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; 326c72ffaaSAndy Whitcroftmy $root; 33c2fdda0dSAndy Whitcroftmy %debug; 343445686aSJoe Perchesmy %camelcase = (); 35*91bfe484SJoe Perchesmy %use_type = (); 36*91bfe484SJoe Perchesmy @use = (); 37*91bfe484SJoe Perchesmy %ignore_type = (); 38000d1cc1SJoe Perchesmy @ignore = (); 3977f5b10aSHannes Edermy $help = 0; 40000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 416cd7f386SJoe Perchesmy $max_line_length = 80; 42d62a201fSDave Hansenmy $ignore_perl_version = 0; 43d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 4477f5b10aSHannes Eder 4577f5b10aSHannes Edersub help { 4677f5b10aSHannes Eder my ($exitcode) = @_; 4777f5b10aSHannes Eder 4877f5b10aSHannes Eder print << "EOM"; 4977f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 5077f5b10aSHannes EderVersion: $V 5177f5b10aSHannes Eder 5277f5b10aSHannes EderOptions: 5377f5b10aSHannes Eder -q, --quiet quiet 5477f5b10aSHannes Eder --no-tree run without a kernel tree 5577f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 5677f5b10aSHannes Eder --patch treat FILE as patchfile (default) 5777f5b10aSHannes Eder --emacs emacs compile window format 5877f5b10aSHannes Eder --terse one line per report 5977f5b10aSHannes Eder -f, --file treat FILE as regular source file 6077f5b10aSHannes Eder --subjective, --strict enable more subjective tests 61*91bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 62000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 636cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 64000d1cc1SJoe Perches --show-types show the message "types" in the output 6577f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 6677f5b10aSHannes Eder --no-summary suppress the per-file summary 6777f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 6877f5b10aSHannes Eder --summary-file include the filename in summary 6977f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 7077f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 7177f5b10aSHannes Eder is all off) 7277f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 7377f5b10aSHannes Eder literally 743705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 753705ce5bSJoe Perches If correctable single-line errors exist, create 763705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 773705ce5bSJoe Perches with potential errors corrected to the preferred 783705ce5bSJoe Perches checkpatch style 79d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 80d62a201fSDave Hansen runtime errors. 8177f5b10aSHannes Eder -h, --help, --version display this help and exit 8277f5b10aSHannes Eder 8377f5b10aSHannes EderWhen FILE is - read standard input. 8477f5b10aSHannes EderEOM 8577f5b10aSHannes Eder 8677f5b10aSHannes Eder exit($exitcode); 8777f5b10aSHannes Eder} 8877f5b10aSHannes Eder 89000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 90000d1cc1SJoe Perchesif (-f $conf) { 91000d1cc1SJoe Perches my @conf_args; 92000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 93000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 94000d1cc1SJoe Perches 95000d1cc1SJoe Perches while (<$conffile>) { 96000d1cc1SJoe Perches my $line = $_; 97000d1cc1SJoe Perches 98000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 99000d1cc1SJoe Perches $line =~ s/^\s*//g; 100000d1cc1SJoe Perches $line =~ s/\s+/ /g; 101000d1cc1SJoe Perches 102000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 103000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 104000d1cc1SJoe Perches 105000d1cc1SJoe Perches my @words = split(" ", $line); 106000d1cc1SJoe Perches foreach my $word (@words) { 107000d1cc1SJoe Perches last if ($word =~ m/^#/); 108000d1cc1SJoe Perches push (@conf_args, $word); 109000d1cc1SJoe Perches } 110000d1cc1SJoe Perches } 111000d1cc1SJoe Perches close($conffile); 112000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 113000d1cc1SJoe Perches} 114000d1cc1SJoe Perches 1150a920b5bSAndy WhitcroftGetOptions( 1166c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1170a920b5bSAndy Whitcroft 'tree!' => \$tree, 1180a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1190a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1206c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1218905a67cSAndy Whitcroft 'terse!' => \$terse, 12277f5b10aSHannes Eder 'f|file!' => \$file, 1236c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1246c72ffaaSAndy Whitcroft 'strict!' => \$check, 125000d1cc1SJoe Perches 'ignore=s' => \@ignore, 126*91bfe484SJoe Perches 'types=s' => \@use, 127000d1cc1SJoe Perches 'show-types!' => \$show_types, 1286cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 1296c72ffaaSAndy Whitcroft 'root=s' => \$root, 1308905a67cSAndy Whitcroft 'summary!' => \$summary, 1318905a67cSAndy Whitcroft 'mailback!' => \$mailback, 13213214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 1333705ce5bSJoe Perches 'fix!' => \$fix, 134d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 135c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 136773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 13777f5b10aSHannes Eder 'h|help' => \$help, 13877f5b10aSHannes Eder 'version' => \$help 13977f5b10aSHannes Eder) or help(1); 14077f5b10aSHannes Eder 14177f5b10aSHannes Ederhelp(0) if ($help); 1420a920b5bSAndy Whitcroft 1430a920b5bSAndy Whitcroftmy $exit = 0; 1440a920b5bSAndy Whitcroft 145d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 146d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 147d62a201fSDave Hansen if (!$ignore_perl_version) { 148d62a201fSDave Hansen exit(1); 149d62a201fSDave Hansen } 150d62a201fSDave Hansen} 151d62a201fSDave Hansen 1520a920b5bSAndy Whitcroftif ($#ARGV < 0) { 15377f5b10aSHannes Eder print "$P: no input files\n"; 1540a920b5bSAndy Whitcroft exit(1); 1550a920b5bSAndy Whitcroft} 1560a920b5bSAndy Whitcroft 157*91bfe484SJoe Perchessub hash_save_array_words { 158*91bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 159*91bfe484SJoe Perches 160*91bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 161*91bfe484SJoe Perches foreach my $word (@array) { 162000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 163000d1cc1SJoe Perches $word =~ s/^\s*//g; 164000d1cc1SJoe Perches $word =~ s/\s+/ /g; 165000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 166000d1cc1SJoe Perches 167000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 168000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 169000d1cc1SJoe Perches 170*91bfe484SJoe Perches $hashRef->{$word}++; 171000d1cc1SJoe Perches } 172*91bfe484SJoe Perches} 173*91bfe484SJoe Perches 174*91bfe484SJoe Perchessub hash_show_words { 175*91bfe484SJoe Perches my ($hashRef, $prefix) = @_; 176*91bfe484SJoe Perches 177*91bfe484SJoe Perches if ($quiet == 0 && keys $hashRef) { 178*91bfe484SJoe Perches print "NOTE: $prefix message types:"; 179*91bfe484SJoe Perches foreach my $word (sort keys $hashRef) { 180*91bfe484SJoe Perches print " $word"; 181*91bfe484SJoe Perches } 182*91bfe484SJoe Perches print "\n\n"; 183*91bfe484SJoe Perches } 184*91bfe484SJoe Perches} 185*91bfe484SJoe Perches 186*91bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 187*91bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 188000d1cc1SJoe Perches 189c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 190c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 1917429c690SAndy Whitcroftmy $dbg_type = 0; 192a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 193c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 19421caa13cSAndy Whitcroft ## no critic 19521caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 19621caa13cSAndy Whitcroft die "$@" if ($@); 197c2fdda0dSAndy Whitcroft} 198c2fdda0dSAndy Whitcroft 199d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 200d2c0a235SAndy Whitcroft 2018905a67cSAndy Whitcroftif ($terse) { 2028905a67cSAndy Whitcroft $emacs = 1; 2038905a67cSAndy Whitcroft $quiet++; 2048905a67cSAndy Whitcroft} 2058905a67cSAndy Whitcroft 2066c72ffaaSAndy Whitcroftif ($tree) { 2076c72ffaaSAndy Whitcroft if (defined $root) { 2086c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 2096c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 2106c72ffaaSAndy Whitcroft } 2116c72ffaaSAndy Whitcroft } else { 2126c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 2136c72ffaaSAndy Whitcroft $root = '.'; 2146c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 2156c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 2166c72ffaaSAndy Whitcroft $root = $1; 2176c72ffaaSAndy Whitcroft } 2186c72ffaaSAndy Whitcroft } 2196c72ffaaSAndy Whitcroft 2206c72ffaaSAndy Whitcroft if (!defined $root) { 2210a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 2220a920b5bSAndy Whitcroft exit(2); 2230a920b5bSAndy Whitcroft } 2246c72ffaaSAndy Whitcroft} 2256c72ffaaSAndy Whitcroft 2266c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 2276c72ffaaSAndy Whitcroft 2282ceb532bSAndy Whitcroftour $Ident = qr{ 2292ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 2302ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 2312ceb532bSAndy Whitcroft }x; 2326c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 2336c72ffaaSAndy Whitcroftour $Sparse = qr{ 2346c72ffaaSAndy Whitcroft __user| 2356c72ffaaSAndy Whitcroft __kernel| 2366c72ffaaSAndy Whitcroft __force| 2376c72ffaaSAndy Whitcroft __iomem| 2386c72ffaaSAndy Whitcroft __must_check| 2396c72ffaaSAndy Whitcroft __init_refok| 240417495edSAndy Whitcroft __kprobes| 241165e72a6SSven Eckelmann __ref| 242165e72a6SSven Eckelmann __rcu 2436c72ffaaSAndy Whitcroft }x; 24452131292SWolfram Sang 24552131292SWolfram Sang# Notes to $Attribute: 24652131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 2476c72ffaaSAndy Whitcroftour $Attribute = qr{ 2486c72ffaaSAndy Whitcroft const| 24903f1df7dSJoe Perches __percpu| 25003f1df7dSJoe Perches __nocast| 25103f1df7dSJoe Perches __safe| 25203f1df7dSJoe Perches __bitwise__| 25303f1df7dSJoe Perches __packed__| 25403f1df7dSJoe Perches __packed2__| 25503f1df7dSJoe Perches __naked| 25603f1df7dSJoe Perches __maybe_unused| 25703f1df7dSJoe Perches __always_unused| 25803f1df7dSJoe Perches __noreturn| 25903f1df7dSJoe Perches __used| 26003f1df7dSJoe Perches __cold| 26103f1df7dSJoe Perches __noclone| 26203f1df7dSJoe Perches __deprecated| 2636c72ffaaSAndy Whitcroft __read_mostly| 2646c72ffaaSAndy Whitcroft __kprobes| 26552131292SWolfram Sang __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)| 26624e1d81aSAndy Whitcroft ____cacheline_aligned| 26724e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 2685fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 2695fe3af11SAndy Whitcroft __weak 2706c72ffaaSAndy Whitcroft }x; 271c45dcabdSAndy Whitcroftour $Modifier; 2726c72ffaaSAndy Whitcroftour $Inline = qr{inline|__always_inline|noinline}; 2736c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 2746c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 2756c72ffaaSAndy Whitcroft 27695e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 27795e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 27895e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 27995e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 280326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 281326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 282326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 28374349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 28495e2c602SJoe Perchesour $Constant = qr{$Float|$Binary|$Hex|$Int}; 285326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 28686f9d059SAndy Whitcroftour $Compare = qr{<=|>=|==|!=|<|>}; 28723f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 2886c72ffaaSAndy Whitcroftour $Operators = qr{ 2896c72ffaaSAndy Whitcroft <=|>=|==|!=| 2906c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 29123f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 2926c72ffaaSAndy Whitcroft }x; 2936c72ffaaSAndy Whitcroft 2948905a67cSAndy Whitcroftour $NonptrType; 2958905a67cSAndy Whitcroftour $Type; 2968905a67cSAndy Whitcroftour $Declare; 2978905a67cSAndy Whitcroft 29815662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 29915662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 300171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 301171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 302171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 303171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 304171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 305171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 306171ae1a4SAndy Whitcroft}x; 307171ae1a4SAndy Whitcroft 30815662b3eSJoe Perchesour $UTF8 = qr{ 30915662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 31015662b3eSJoe Perches | $NON_ASCII_UTF8 31115662b3eSJoe Perches}x; 31215662b3eSJoe Perches 3138ed22cadSAndy Whitcroftour $typeTypedefs = qr{(?x: 314fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 3158ed22cadSAndy Whitcroft atomic_t 3168ed22cadSAndy Whitcroft)}; 3178ed22cadSAndy Whitcroft 318691e669bSJoe Perchesour $logFunctions = qr{(?x: 3196e60c02eSJoe Perches printk(?:_ratelimited|_once|)| 3207d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 3216e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 322b0531722SJoe Perches panic| 323b0531722SJoe Perches MODULE_[A-Z_]+ 324691e669bSJoe Perches)}; 325691e669bSJoe Perches 32620112475SJoe Perchesour $signature_tags = qr{(?xi: 32720112475SJoe Perches Signed-off-by:| 32820112475SJoe Perches Acked-by:| 32920112475SJoe Perches Tested-by:| 33020112475SJoe Perches Reviewed-by:| 33120112475SJoe Perches Reported-by:| 3328543ae12SMugunthan V N Suggested-by:| 33320112475SJoe Perches To:| 33420112475SJoe Perches Cc: 33520112475SJoe Perches)}; 33620112475SJoe Perches 3378905a67cSAndy Whitcroftour @typeList = ( 3388905a67cSAndy Whitcroft qr{void}, 339c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?char}, 340c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?short}, 341c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?int}, 342c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long}, 343c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+int}, 344c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long}, 345c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long\s+int}, 3468905a67cSAndy Whitcroft qr{unsigned}, 3478905a67cSAndy Whitcroft qr{float}, 3488905a67cSAndy Whitcroft qr{double}, 3498905a67cSAndy Whitcroft qr{bool}, 3508905a67cSAndy Whitcroft qr{struct\s+$Ident}, 3518905a67cSAndy Whitcroft qr{union\s+$Ident}, 3528905a67cSAndy Whitcroft qr{enum\s+$Ident}, 3538905a67cSAndy Whitcroft qr{${Ident}_t}, 3548905a67cSAndy Whitcroft qr{${Ident}_handler}, 3558905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 3568905a67cSAndy Whitcroft); 357c45dcabdSAndy Whitcroftour @modifierList = ( 358c45dcabdSAndy Whitcroft qr{fastcall}, 359c45dcabdSAndy Whitcroft); 3608905a67cSAndy Whitcroft 3617840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 3627840a94cSWolfram Sang irq| 3637840a94cSWolfram Sang memory 3647840a94cSWolfram Sang)}; 3657840a94cSWolfram Sang# memory.h: ARM has a custom one 3667840a94cSWolfram Sang 3678905a67cSAndy Whitcroftsub build_types { 368d2172eb5SAndy Whitcroft my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; 369d2172eb5SAndy Whitcroft my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; 370c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 3718905a67cSAndy Whitcroft $NonptrType = qr{ 372d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 373cf655043SAndy Whitcroft (?: 3746b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 3758ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 376c45dcabdSAndy Whitcroft (?:${all}\b) 377cf655043SAndy Whitcroft ) 378c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 3798905a67cSAndy Whitcroft }x; 3808905a67cSAndy Whitcroft $Type = qr{ 381c45dcabdSAndy Whitcroft $NonptrType 382b337d8b8SAndy Whitcroft (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)? 383c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 3848905a67cSAndy Whitcroft }x; 3858905a67cSAndy Whitcroft $Declare = qr{(?:$Storage\s+)?$Type}; 3868905a67cSAndy Whitcroft} 3878905a67cSAndy Whitcroftbuild_types(); 3886c72ffaaSAndy Whitcroft 3897d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 390d1fe9c09SJoe Perches 391d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 392d1fe9c09SJoe Perches# requires at least perl version v5.10.0 393d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 394d1fe9c09SJoe Perches 395d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 396d1fe9c09SJoe Perchesour $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*}; 397d7c76ba7SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)}; 3987d2367afSJoe Perches 3997d2367afSJoe Perchessub deparenthesize { 4007d2367afSJoe Perches my ($string) = @_; 4017d2367afSJoe Perches return "" if (!defined($string)); 4027d2367afSJoe Perches $string =~ s@^\s*\(\s*@@g; 4037d2367afSJoe Perches $string =~ s@\s*\)\s*$@@g; 4047d2367afSJoe Perches $string =~ s@\s+@ @g; 4057d2367afSJoe Perches return $string; 4067d2367afSJoe Perches} 4077d2367afSJoe Perches 4083445686aSJoe Perchessub seed_camelcase_file { 4093445686aSJoe Perches my ($file) = @_; 4103445686aSJoe Perches 4113445686aSJoe Perches return if (!(-f $file)); 4123445686aSJoe Perches 4133445686aSJoe Perches local $/; 4143445686aSJoe Perches 4153445686aSJoe Perches open(my $include_file, '<', "$file") 4163445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 4173445686aSJoe Perches my $text = <$include_file>; 4183445686aSJoe Perches close($include_file); 4193445686aSJoe Perches 4203445686aSJoe Perches my @lines = split('\n', $text); 4213445686aSJoe Perches 4223445686aSJoe Perches foreach my $line (@lines) { 4233445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 4243445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 4253445686aSJoe Perches $camelcase{$1} = 1; 4263445686aSJoe Perches } 4273445686aSJoe Perches elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*\(/) { 4283445686aSJoe Perches $camelcase{$1} = 1; 4293445686aSJoe Perches } 4303445686aSJoe Perches } 4313445686aSJoe Perches} 4323445686aSJoe Perches 4333445686aSJoe Perchesmy $camelcase_seeded = 0; 4343445686aSJoe Perchessub seed_camelcase_includes { 4353445686aSJoe Perches return if ($camelcase_seeded); 4363445686aSJoe Perches 4373445686aSJoe Perches my $files; 438c707a81dSJoe Perches my $camelcase_cache = ""; 439c707a81dSJoe Perches my @include_files = (); 440c707a81dSJoe Perches 441c707a81dSJoe Perches $camelcase_seeded = 1; 442351b2a1fSJoe Perches 4433445686aSJoe Perches if (-d ".git") { 444351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 445351b2a1fSJoe Perches chomp $git_last_include_commit; 446c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 447c707a81dSJoe Perches } else { 448c707a81dSJoe Perches my $last_mod_date = 0; 449c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 450c707a81dSJoe Perches @include_files = split('\n', $files); 451c707a81dSJoe Perches foreach my $file (@include_files) { 452c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 453c707a81dSJoe Perches localtime((stat $file)[9])); 454c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 455c707a81dSJoe Perches } 456c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 457c707a81dSJoe Perches } 458c707a81dSJoe Perches 459c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 460c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 461c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 462351b2a1fSJoe Perches while (<$camelcase_file>) { 463351b2a1fSJoe Perches chomp; 464351b2a1fSJoe Perches $camelcase{$_} = 1; 465351b2a1fSJoe Perches } 466351b2a1fSJoe Perches close($camelcase_file); 467351b2a1fSJoe Perches 468351b2a1fSJoe Perches return; 469351b2a1fSJoe Perches } 470c707a81dSJoe Perches 471c707a81dSJoe Perches if (-d ".git") { 472c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 473c707a81dSJoe Perches @include_files = split('\n', $files); 4743445686aSJoe Perches } 475c707a81dSJoe Perches 4763445686aSJoe Perches foreach my $file (@include_files) { 4773445686aSJoe Perches seed_camelcase_file($file); 4783445686aSJoe Perches } 479351b2a1fSJoe Perches 480c707a81dSJoe Perches if ($camelcase_cache ne "") { 481351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 482c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 483c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 484351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 485351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 486351b2a1fSJoe Perches } 487351b2a1fSJoe Perches close($camelcase_file); 488351b2a1fSJoe Perches } 4893445686aSJoe Perches} 4903445686aSJoe Perches 4916c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 4920a920b5bSAndy Whitcroft 49300df344fSAndy Whitcroftmy @rawlines = (); 494c2fdda0dSAndy Whitcroftmy @lines = (); 4953705ce5bSJoe Perchesmy @fixed = (); 496c2fdda0dSAndy Whitcroftmy $vname; 4976c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 49821caa13cSAndy Whitcroft my $FILE; 4996c72ffaaSAndy Whitcroft if ($file) { 50021caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 5016c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 50221caa13cSAndy Whitcroft } elsif ($filename eq '-') { 50321caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 5046c72ffaaSAndy Whitcroft } else { 50521caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 5066c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 5076c72ffaaSAndy Whitcroft } 508c2fdda0dSAndy Whitcroft if ($filename eq '-') { 509c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 510c2fdda0dSAndy Whitcroft } else { 511c2fdda0dSAndy Whitcroft $vname = $filename; 512c2fdda0dSAndy Whitcroft } 51321caa13cSAndy Whitcroft while (<$FILE>) { 5140a920b5bSAndy Whitcroft chomp; 51500df344fSAndy Whitcroft push(@rawlines, $_); 5166c72ffaaSAndy Whitcroft } 51721caa13cSAndy Whitcroft close($FILE); 518c2fdda0dSAndy Whitcroft if (!process($filename)) { 5190a920b5bSAndy Whitcroft $exit = 1; 5200a920b5bSAndy Whitcroft } 52100df344fSAndy Whitcroft @rawlines = (); 52213214adfSAndy Whitcroft @lines = (); 5233705ce5bSJoe Perches @fixed = (); 5240a920b5bSAndy Whitcroft} 5250a920b5bSAndy Whitcroft 5260a920b5bSAndy Whitcroftexit($exit); 5270a920b5bSAndy Whitcroft 5280a920b5bSAndy Whitcroftsub top_of_kernel_tree { 5296c72ffaaSAndy Whitcroft my ($root) = @_; 5306c72ffaaSAndy Whitcroft 5316c72ffaaSAndy Whitcroft my @tree_check = ( 5326c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 5336c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 5346c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 5356c72ffaaSAndy Whitcroft ); 5366c72ffaaSAndy Whitcroft 5376c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 5386c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 5390a920b5bSAndy Whitcroft return 0; 5400a920b5bSAndy Whitcroft } 5416c72ffaaSAndy Whitcroft } 5426c72ffaaSAndy Whitcroft return 1; 5436c72ffaaSAndy Whitcroft} 5440a920b5bSAndy Whitcroft 54520112475SJoe Perchessub parse_email { 54620112475SJoe Perches my ($formatted_email) = @_; 54720112475SJoe Perches 54820112475SJoe Perches my $name = ""; 54920112475SJoe Perches my $address = ""; 55020112475SJoe Perches my $comment = ""; 55120112475SJoe Perches 55220112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 55320112475SJoe Perches $name = $1; 55420112475SJoe Perches $address = $2; 55520112475SJoe Perches $comment = $3 if defined $3; 55620112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 55720112475SJoe Perches $address = $1; 55820112475SJoe Perches $comment = $2 if defined $2; 55920112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 56020112475SJoe Perches $address = $1; 56120112475SJoe Perches $comment = $2 if defined $2; 56220112475SJoe Perches $formatted_email =~ s/$address.*$//; 56320112475SJoe Perches $name = $formatted_email; 5643705ce5bSJoe Perches $name = trim($name); 56520112475SJoe Perches $name =~ s/^\"|\"$//g; 56620112475SJoe Perches # If there's a name left after stripping spaces and 56720112475SJoe Perches # leading quotes, and the address doesn't have both 56820112475SJoe Perches # leading and trailing angle brackets, the address 56920112475SJoe Perches # is invalid. ie: 57020112475SJoe Perches # "joe smith [email protected]" bad 57120112475SJoe Perches # "joe smith <[email protected]" bad 57220112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 57320112475SJoe Perches $name = ""; 57420112475SJoe Perches $address = ""; 57520112475SJoe Perches $comment = ""; 57620112475SJoe Perches } 57720112475SJoe Perches } 57820112475SJoe Perches 5793705ce5bSJoe Perches $name = trim($name); 58020112475SJoe Perches $name =~ s/^\"|\"$//g; 5813705ce5bSJoe Perches $address = trim($address); 58220112475SJoe Perches $address =~ s/^\<|\>$//g; 58320112475SJoe Perches 58420112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 58520112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 58620112475SJoe Perches $name = "\"$name\""; 58720112475SJoe Perches } 58820112475SJoe Perches 58920112475SJoe Perches return ($name, $address, $comment); 59020112475SJoe Perches} 59120112475SJoe Perches 59220112475SJoe Perchessub format_email { 59320112475SJoe Perches my ($name, $address) = @_; 59420112475SJoe Perches 59520112475SJoe Perches my $formatted_email; 59620112475SJoe Perches 5973705ce5bSJoe Perches $name = trim($name); 59820112475SJoe Perches $name =~ s/^\"|\"$//g; 5993705ce5bSJoe Perches $address = trim($address); 60020112475SJoe Perches 60120112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 60220112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 60320112475SJoe Perches $name = "\"$name\""; 60420112475SJoe Perches } 60520112475SJoe Perches 60620112475SJoe Perches if ("$name" eq "") { 60720112475SJoe Perches $formatted_email = "$address"; 60820112475SJoe Perches } else { 60920112475SJoe Perches $formatted_email = "$name <$address>"; 61020112475SJoe Perches } 61120112475SJoe Perches 61220112475SJoe Perches return $formatted_email; 61320112475SJoe Perches} 61420112475SJoe Perches 615000d1cc1SJoe Perchessub which_conf { 616000d1cc1SJoe Perches my ($conf) = @_; 617000d1cc1SJoe Perches 618000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 619000d1cc1SJoe Perches if (-e "$path/$conf") { 620000d1cc1SJoe Perches return "$path/$conf"; 621000d1cc1SJoe Perches } 622000d1cc1SJoe Perches } 623000d1cc1SJoe Perches 624000d1cc1SJoe Perches return ""; 625000d1cc1SJoe Perches} 626000d1cc1SJoe Perches 6270a920b5bSAndy Whitcroftsub expand_tabs { 6280a920b5bSAndy Whitcroft my ($str) = @_; 6290a920b5bSAndy Whitcroft 6300a920b5bSAndy Whitcroft my $res = ''; 6310a920b5bSAndy Whitcroft my $n = 0; 6320a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 6330a920b5bSAndy Whitcroft if ($c eq "\t") { 6340a920b5bSAndy Whitcroft $res .= ' '; 6350a920b5bSAndy Whitcroft $n++; 6360a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 6370a920b5bSAndy Whitcroft $res .= ' '; 6380a920b5bSAndy Whitcroft } 6390a920b5bSAndy Whitcroft next; 6400a920b5bSAndy Whitcroft } 6410a920b5bSAndy Whitcroft $res .= $c; 6420a920b5bSAndy Whitcroft $n++; 6430a920b5bSAndy Whitcroft } 6440a920b5bSAndy Whitcroft 6450a920b5bSAndy Whitcroft return $res; 6460a920b5bSAndy Whitcroft} 6476c72ffaaSAndy Whitcroftsub copy_spacing { 648773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 6496c72ffaaSAndy Whitcroft return $res; 6506c72ffaaSAndy Whitcroft} 6510a920b5bSAndy Whitcroft 6524a0df2efSAndy Whitcroftsub line_stats { 6534a0df2efSAndy Whitcroft my ($line) = @_; 6544a0df2efSAndy Whitcroft 6554a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 6564a0df2efSAndy Whitcroft $line =~ s/^.//; 6574a0df2efSAndy Whitcroft $line = expand_tabs($line); 6584a0df2efSAndy Whitcroft 6594a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 6604a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 6614a0df2efSAndy Whitcroft 6624a0df2efSAndy Whitcroft return (length($line), length($white)); 6634a0df2efSAndy Whitcroft} 6644a0df2efSAndy Whitcroft 665773647a0SAndy Whitcroftmy $sanitise_quote = ''; 666773647a0SAndy Whitcroft 667773647a0SAndy Whitcroftsub sanitise_line_reset { 668773647a0SAndy Whitcroft my ($in_comment) = @_; 669773647a0SAndy Whitcroft 670773647a0SAndy Whitcroft if ($in_comment) { 671773647a0SAndy Whitcroft $sanitise_quote = '*/'; 672773647a0SAndy Whitcroft } else { 673773647a0SAndy Whitcroft $sanitise_quote = ''; 674773647a0SAndy Whitcroft } 675773647a0SAndy Whitcroft} 67600df344fSAndy Whitcroftsub sanitise_line { 67700df344fSAndy Whitcroft my ($line) = @_; 67800df344fSAndy Whitcroft 67900df344fSAndy Whitcroft my $res = ''; 68000df344fSAndy Whitcroft my $l = ''; 68100df344fSAndy Whitcroft 682c2fdda0dSAndy Whitcroft my $qlen = 0; 683773647a0SAndy Whitcroft my $off = 0; 684773647a0SAndy Whitcroft my $c; 68500df344fSAndy Whitcroft 686773647a0SAndy Whitcroft # Always copy over the diff marker. 687773647a0SAndy Whitcroft $res = substr($line, 0, 1); 688773647a0SAndy Whitcroft 689773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 690773647a0SAndy Whitcroft $c = substr($line, $off, 1); 691773647a0SAndy Whitcroft 692773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 693773647a0SAndy Whitcroft # and end, all to $;. 694773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 695773647a0SAndy Whitcroft $sanitise_quote = '*/'; 696773647a0SAndy Whitcroft 697773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 698773647a0SAndy Whitcroft $off++; 69900df344fSAndy Whitcroft next; 700773647a0SAndy Whitcroft } 70181bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 702773647a0SAndy Whitcroft $sanitise_quote = ''; 703773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 704773647a0SAndy Whitcroft $off++; 705773647a0SAndy Whitcroft next; 706773647a0SAndy Whitcroft } 707113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 708113f04a8SDaniel Walker $sanitise_quote = '//'; 709113f04a8SDaniel Walker 710113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 711113f04a8SDaniel Walker $off++; 712113f04a8SDaniel Walker next; 713113f04a8SDaniel Walker } 714773647a0SAndy Whitcroft 715773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 716773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 717773647a0SAndy Whitcroft $c eq "\\") { 718773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 719773647a0SAndy Whitcroft $off++; 720773647a0SAndy Whitcroft next; 721773647a0SAndy Whitcroft } 722773647a0SAndy Whitcroft # Regular quotes. 723773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 724773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 725773647a0SAndy Whitcroft $sanitise_quote = $c; 726773647a0SAndy Whitcroft 727773647a0SAndy Whitcroft substr($res, $off, 1, $c); 728773647a0SAndy Whitcroft next; 729773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 730773647a0SAndy Whitcroft $sanitise_quote = ''; 73100df344fSAndy Whitcroft } 73200df344fSAndy Whitcroft } 733773647a0SAndy Whitcroft 734fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 735773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 736773647a0SAndy Whitcroft substr($res, $off, 1, $;); 737113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 738113f04a8SDaniel Walker substr($res, $off, 1, $;); 739773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 740773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 74100df344fSAndy Whitcroft } else { 742773647a0SAndy Whitcroft substr($res, $off, 1, $c); 74300df344fSAndy Whitcroft } 744c2fdda0dSAndy Whitcroft } 745c2fdda0dSAndy Whitcroft 746113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 747113f04a8SDaniel Walker $sanitise_quote = ''; 748113f04a8SDaniel Walker } 749113f04a8SDaniel Walker 750c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 751c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 752c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 753c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 754c2fdda0dSAndy Whitcroft 755c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 756c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 757c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 758c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 759c2fdda0dSAndy Whitcroft } 760c2fdda0dSAndy Whitcroft 76100df344fSAndy Whitcroft return $res; 76200df344fSAndy Whitcroft} 76300df344fSAndy Whitcroft 764a6962d72SJoe Perchessub get_quoted_string { 765a6962d72SJoe Perches my ($line, $rawline) = @_; 766a6962d72SJoe Perches 767a6962d72SJoe Perches return "" if ($line !~ m/(\"[X]+\")/g); 768a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 769a6962d72SJoe Perches} 770a6962d72SJoe Perches 7718905a67cSAndy Whitcroftsub ctx_statement_block { 7728905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 7738905a67cSAndy Whitcroft my $line = $linenr - 1; 7748905a67cSAndy Whitcroft my $blk = ''; 7758905a67cSAndy Whitcroft my $soff = $off; 7768905a67cSAndy Whitcroft my $coff = $off - 1; 777773647a0SAndy Whitcroft my $coff_set = 0; 7788905a67cSAndy Whitcroft 77913214adfSAndy Whitcroft my $loff = 0; 78013214adfSAndy Whitcroft 7818905a67cSAndy Whitcroft my $type = ''; 7828905a67cSAndy Whitcroft my $level = 0; 783a2750645SAndy Whitcroft my @stack = (); 784cf655043SAndy Whitcroft my $p; 7858905a67cSAndy Whitcroft my $c; 7868905a67cSAndy Whitcroft my $len = 0; 78713214adfSAndy Whitcroft 78813214adfSAndy Whitcroft my $remainder; 7898905a67cSAndy Whitcroft while (1) { 790a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 791a2750645SAndy Whitcroft 792773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 7938905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 7948905a67cSAndy Whitcroft # context. 7958905a67cSAndy Whitcroft if ($off >= $len) { 7968905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 797dea33496SAndy Whitcroft last if (!defined $lines[$line]); 798c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 7998905a67cSAndy Whitcroft $remain--; 80013214adfSAndy Whitcroft $loff = $len; 801c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 8028905a67cSAndy Whitcroft $len = length($blk); 8038905a67cSAndy Whitcroft $line++; 8048905a67cSAndy Whitcroft last; 8058905a67cSAndy Whitcroft } 8068905a67cSAndy Whitcroft # Bail if there is no further context. 8078905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 80813214adfSAndy Whitcroft if ($off >= $len) { 8098905a67cSAndy Whitcroft last; 8108905a67cSAndy Whitcroft } 811f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 812f74bd194SAndy Whitcroft $level++; 813f74bd194SAndy Whitcroft $type = '#'; 814f74bd194SAndy Whitcroft } 8158905a67cSAndy Whitcroft } 816cf655043SAndy Whitcroft $p = $c; 8178905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 81813214adfSAndy Whitcroft $remainder = substr($blk, $off); 8198905a67cSAndy Whitcroft 820773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 8214635f4fbSAndy Whitcroft 8224635f4fbSAndy Whitcroft # Handle nested #if/#else. 8234635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 8244635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 8254635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 8264635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 8274635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 8284635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 8294635f4fbSAndy Whitcroft } 8304635f4fbSAndy Whitcroft 8318905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 8328905a67cSAndy Whitcroft # outermost level. 8338905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 8348905a67cSAndy Whitcroft last; 8358905a67cSAndy Whitcroft } 8368905a67cSAndy Whitcroft 83713214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 838773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 839773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 840773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 841773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 842773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 843773647a0SAndy Whitcroft $coff_set = 1; 844773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 845773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 84613214adfSAndy Whitcroft } 84713214adfSAndy Whitcroft 8488905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 8498905a67cSAndy Whitcroft $level++; 8508905a67cSAndy Whitcroft $type = '('; 8518905a67cSAndy Whitcroft } 8528905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 8538905a67cSAndy Whitcroft $level--; 8548905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 8558905a67cSAndy Whitcroft 8568905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 8578905a67cSAndy Whitcroft $coff = $off; 858773647a0SAndy Whitcroft $coff_set = 1; 859773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 8608905a67cSAndy Whitcroft } 8618905a67cSAndy Whitcroft } 8628905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 8638905a67cSAndy Whitcroft $level++; 8648905a67cSAndy Whitcroft $type = '{'; 8658905a67cSAndy Whitcroft } 8668905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 8678905a67cSAndy Whitcroft $level--; 8688905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 8698905a67cSAndy Whitcroft 8708905a67cSAndy Whitcroft if ($level == 0) { 871b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 872b998e001SPatrick Pannuto $off++; 873b998e001SPatrick Pannuto } 8748905a67cSAndy Whitcroft last; 8758905a67cSAndy Whitcroft } 8768905a67cSAndy Whitcroft } 877f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 878f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 879f74bd194SAndy Whitcroft $level--; 880f74bd194SAndy Whitcroft $type = ''; 881f74bd194SAndy Whitcroft $off++; 882f74bd194SAndy Whitcroft last; 883f74bd194SAndy Whitcroft } 8848905a67cSAndy Whitcroft $off++; 8858905a67cSAndy Whitcroft } 886a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 88713214adfSAndy Whitcroft if ($off == $len) { 888a3bb97a7SAndy Whitcroft $loff = $len + 1; 88913214adfSAndy Whitcroft $line++; 89013214adfSAndy Whitcroft $remain--; 89113214adfSAndy Whitcroft } 8928905a67cSAndy Whitcroft 8938905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 8948905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 8958905a67cSAndy Whitcroft 8968905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 8978905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 8988905a67cSAndy Whitcroft 899773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 90013214adfSAndy Whitcroft 90113214adfSAndy Whitcroft return ($statement, $condition, 90213214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 90313214adfSAndy Whitcroft} 90413214adfSAndy Whitcroft 905cf655043SAndy Whitcroftsub statement_lines { 906cf655043SAndy Whitcroft my ($stmt) = @_; 907cf655043SAndy Whitcroft 908cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 909cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 910cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 911cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 912cf655043SAndy Whitcroft 913cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 914cf655043SAndy Whitcroft 915cf655043SAndy Whitcroft return $#stmt_lines + 2; 916cf655043SAndy Whitcroft} 917cf655043SAndy Whitcroft 918cf655043SAndy Whitcroftsub statement_rawlines { 919cf655043SAndy Whitcroft my ($stmt) = @_; 920cf655043SAndy Whitcroft 921cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 922cf655043SAndy Whitcroft 923cf655043SAndy Whitcroft return $#stmt_lines + 2; 924cf655043SAndy Whitcroft} 925cf655043SAndy Whitcroft 926cf655043SAndy Whitcroftsub statement_block_size { 927cf655043SAndy Whitcroft my ($stmt) = @_; 928cf655043SAndy Whitcroft 929cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 930cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 931cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 932cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 933cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 934cf655043SAndy Whitcroft 935cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 936cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 937cf655043SAndy Whitcroft 938cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 939cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 940cf655043SAndy Whitcroft 941cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 942cf655043SAndy Whitcroft return $stmt_lines; 943cf655043SAndy Whitcroft } else { 944cf655043SAndy Whitcroft return $stmt_statements; 945cf655043SAndy Whitcroft } 946cf655043SAndy Whitcroft} 947cf655043SAndy Whitcroft 94813214adfSAndy Whitcroftsub ctx_statement_full { 94913214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 95013214adfSAndy Whitcroft my ($statement, $condition, $level); 95113214adfSAndy Whitcroft 95213214adfSAndy Whitcroft my (@chunks); 95313214adfSAndy Whitcroft 954cf655043SAndy Whitcroft # Grab the first conditional/block pair. 95513214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 95613214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 957773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 95813214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 959cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 960cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 961cf655043SAndy Whitcroft } 962cf655043SAndy Whitcroft 963cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 964cf655043SAndy Whitcroft # could continue the statement. 965cf655043SAndy Whitcroft for (;;) { 96613214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 96713214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 968cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 969773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 970cf655043SAndy Whitcroft #print "C: push\n"; 971cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 97213214adfSAndy Whitcroft } 97313214adfSAndy Whitcroft 97413214adfSAndy Whitcroft return ($level, $linenr, @chunks); 9758905a67cSAndy Whitcroft} 9768905a67cSAndy Whitcroft 9774a0df2efSAndy Whitcroftsub ctx_block_get { 978f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 9794a0df2efSAndy Whitcroft my $line; 9804a0df2efSAndy Whitcroft my $start = $linenr - 1; 9814a0df2efSAndy Whitcroft my $blk = ''; 9824a0df2efSAndy Whitcroft my @o; 9834a0df2efSAndy Whitcroft my @c; 9844a0df2efSAndy Whitcroft my @res = (); 9854a0df2efSAndy Whitcroft 986f0a594c1SAndy Whitcroft my $level = 0; 9874635f4fbSAndy Whitcroft my @stack = ($level); 98800df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 98900df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 99000df344fSAndy Whitcroft $remain--; 99100df344fSAndy Whitcroft 99200df344fSAndy Whitcroft $blk .= $rawlines[$line]; 9934635f4fbSAndy Whitcroft 9944635f4fbSAndy Whitcroft # Handle nested #if/#else. 99501464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 9964635f4fbSAndy Whitcroft push(@stack, $level); 99701464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 9984635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 99901464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 10004635f4fbSAndy Whitcroft $level = pop(@stack); 10014635f4fbSAndy Whitcroft } 10024635f4fbSAndy Whitcroft 100301464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1004f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1005f0a594c1SAndy Whitcroft if ($off > 0) { 1006f0a594c1SAndy Whitcroft $off--; 1007f0a594c1SAndy Whitcroft next; 1008f0a594c1SAndy Whitcroft } 10094a0df2efSAndy Whitcroft 1010f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1011f0a594c1SAndy Whitcroft $level--; 1012f0a594c1SAndy Whitcroft last if ($level == 0); 1013f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1014f0a594c1SAndy Whitcroft $level++; 1015f0a594c1SAndy Whitcroft } 1016f0a594c1SAndy Whitcroft } 10174a0df2efSAndy Whitcroft 1018f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 101900df344fSAndy Whitcroft push(@res, $rawlines[$line]); 10204a0df2efSAndy Whitcroft } 10214a0df2efSAndy Whitcroft 1022f0a594c1SAndy Whitcroft last if ($level == 0); 10234a0df2efSAndy Whitcroft } 10244a0df2efSAndy Whitcroft 1025f0a594c1SAndy Whitcroft return ($level, @res); 10264a0df2efSAndy Whitcroft} 10274a0df2efSAndy Whitcroftsub ctx_block_outer { 10284a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 10294a0df2efSAndy Whitcroft 1030f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1031f0a594c1SAndy Whitcroft return @r; 10324a0df2efSAndy Whitcroft} 10334a0df2efSAndy Whitcroftsub ctx_block { 10344a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 10354a0df2efSAndy Whitcroft 1036f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1037f0a594c1SAndy Whitcroft return @r; 1038653d4876SAndy Whitcroft} 1039653d4876SAndy Whitcroftsub ctx_statement { 1040f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1041f0a594c1SAndy Whitcroft 1042f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1043f0a594c1SAndy Whitcroft return @r; 1044f0a594c1SAndy Whitcroft} 1045f0a594c1SAndy Whitcroftsub ctx_block_level { 1046653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1047653d4876SAndy Whitcroft 1048f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 10494a0df2efSAndy Whitcroft} 10509c0ca6f9SAndy Whitcroftsub ctx_statement_level { 10519c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 10529c0ca6f9SAndy Whitcroft 10539c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 10549c0ca6f9SAndy Whitcroft} 10554a0df2efSAndy Whitcroft 10564a0df2efSAndy Whitcroftsub ctx_locate_comment { 10574a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 10584a0df2efSAndy Whitcroft 10594a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1060beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 10614a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 10624a0df2efSAndy Whitcroft 10634a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 10644a0df2efSAndy Whitcroft # comment. 10654a0df2efSAndy Whitcroft my $in_comment = 0; 10664a0df2efSAndy Whitcroft $current_comment = ''; 10674a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 106800df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 106900df344fSAndy Whitcroft #warn " $line\n"; 10704a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 10714a0df2efSAndy Whitcroft $in_comment = 1; 10724a0df2efSAndy Whitcroft } 10734a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 10744a0df2efSAndy Whitcroft $in_comment = 1; 10754a0df2efSAndy Whitcroft } 10764a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 10774a0df2efSAndy Whitcroft $current_comment = ''; 10784a0df2efSAndy Whitcroft } 10794a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 10804a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 10814a0df2efSAndy Whitcroft $in_comment = 0; 10824a0df2efSAndy Whitcroft } 10834a0df2efSAndy Whitcroft } 10844a0df2efSAndy Whitcroft 10854a0df2efSAndy Whitcroft chomp($current_comment); 10864a0df2efSAndy Whitcroft return($current_comment); 10874a0df2efSAndy Whitcroft} 10884a0df2efSAndy Whitcroftsub ctx_has_comment { 10894a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 10904a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 10914a0df2efSAndy Whitcroft 109200df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 10934a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 10944a0df2efSAndy Whitcroft 10954a0df2efSAndy Whitcroft return ($cmt ne ''); 10964a0df2efSAndy Whitcroft} 10974a0df2efSAndy Whitcroft 10984d001e4dSAndy Whitcroftsub raw_line { 10994d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 11004d001e4dSAndy Whitcroft 11014d001e4dSAndy Whitcroft my $offset = $linenr - 1; 11024d001e4dSAndy Whitcroft $cnt++; 11034d001e4dSAndy Whitcroft 11044d001e4dSAndy Whitcroft my $line; 11054d001e4dSAndy Whitcroft while ($cnt) { 11064d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 11074d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 11084d001e4dSAndy Whitcroft $cnt--; 11094d001e4dSAndy Whitcroft } 11104d001e4dSAndy Whitcroft 11114d001e4dSAndy Whitcroft return $line; 11124d001e4dSAndy Whitcroft} 11134d001e4dSAndy Whitcroft 11140a920b5bSAndy Whitcroftsub cat_vet { 11150a920b5bSAndy Whitcroft my ($vet) = @_; 11169c0ca6f9SAndy Whitcroft my ($res, $coded); 11170a920b5bSAndy Whitcroft 11189c0ca6f9SAndy Whitcroft $res = ''; 11196c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 11206c72ffaaSAndy Whitcroft $res .= $1; 11216c72ffaaSAndy Whitcroft if ($2 ne '') { 11229c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 11236c72ffaaSAndy Whitcroft $res .= $coded; 11246c72ffaaSAndy Whitcroft } 11259c0ca6f9SAndy Whitcroft } 11269c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 11270a920b5bSAndy Whitcroft 11289c0ca6f9SAndy Whitcroft return $res; 11290a920b5bSAndy Whitcroft} 11300a920b5bSAndy Whitcroft 1131c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1132cf655043SAndy Whitcroftmy $av_pending; 1133c2fdda0dSAndy Whitcroftmy @av_paren_type; 11341f65f947SAndy Whitcroftmy $av_pend_colon; 1135c2fdda0dSAndy Whitcroft 1136c2fdda0dSAndy Whitcroftsub annotate_reset { 1137c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1138cf655043SAndy Whitcroft $av_pending = '_'; 1139cf655043SAndy Whitcroft @av_paren_type = ('E'); 11401f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1141c2fdda0dSAndy Whitcroft} 1142c2fdda0dSAndy Whitcroft 11436c72ffaaSAndy Whitcroftsub annotate_values { 11446c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 11456c72ffaaSAndy Whitcroft 11466c72ffaaSAndy Whitcroft my $res; 11471f65f947SAndy Whitcroft my $var = '_' x length($stream); 11486c72ffaaSAndy Whitcroft my $cur = $stream; 11496c72ffaaSAndy Whitcroft 1150c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 11516c72ffaaSAndy Whitcroft 11526c72ffaaSAndy Whitcroft while (length($cur)) { 1153773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1154cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1155171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 11566c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1157c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1158c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1159cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1160c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 11616c72ffaaSAndy Whitcroft } 11626c72ffaaSAndy Whitcroft 1163c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 11649446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 11659446ef56SAndy Whitcroft push(@av_paren_type, $type); 1166addcdceaSAndy Whitcroft $type = 'c'; 11679446ef56SAndy Whitcroft 1168e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1169c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 11706c72ffaaSAndy Whitcroft $type = 'T'; 11716c72ffaaSAndy Whitcroft 1172389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1173389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1174389a2fe5SAndy Whitcroft $type = 'T'; 1175389a2fe5SAndy Whitcroft 1176c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1177171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1178c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1179171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1180171ae1a4SAndy Whitcroft if ($2 ne '') { 1181cf655043SAndy Whitcroft $av_pending = 'N'; 1182171ae1a4SAndy Whitcroft } 1183171ae1a4SAndy Whitcroft $type = 'E'; 1184171ae1a4SAndy Whitcroft 1185c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1186171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1187171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1188171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 11896c72ffaaSAndy Whitcroft 1190c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1191cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1192c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1193cf655043SAndy Whitcroft 1194cf655043SAndy Whitcroft push(@av_paren_type, $type); 1195cf655043SAndy Whitcroft push(@av_paren_type, $type); 1196171ae1a4SAndy Whitcroft $type = 'E'; 1197cf655043SAndy Whitcroft 1198c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1199cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1200cf655043SAndy Whitcroft $av_preprocessor = 1; 1201cf655043SAndy Whitcroft 1202cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1203cf655043SAndy Whitcroft 1204171ae1a4SAndy Whitcroft $type = 'E'; 1205cf655043SAndy Whitcroft 1206c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1207cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1208cf655043SAndy Whitcroft 1209cf655043SAndy Whitcroft $av_preprocessor = 1; 1210cf655043SAndy Whitcroft 1211cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1212cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1213cf655043SAndy Whitcroft pop(@av_paren_type); 1214cf655043SAndy Whitcroft push(@av_paren_type, $type); 1215171ae1a4SAndy Whitcroft $type = 'E'; 12166c72ffaaSAndy Whitcroft 12176c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1218c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 12196c72ffaaSAndy Whitcroft 1220171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1221171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1222171ae1a4SAndy Whitcroft $av_pending = $type; 1223171ae1a4SAndy Whitcroft $type = 'N'; 1224171ae1a4SAndy Whitcroft 12256c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1226c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 12276c72ffaaSAndy Whitcroft if (defined $2) { 1228cf655043SAndy Whitcroft $av_pending = 'V'; 12296c72ffaaSAndy Whitcroft } 12306c72ffaaSAndy Whitcroft $type = 'N'; 12316c72ffaaSAndy Whitcroft 123214b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1233c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 123414b111c1SAndy Whitcroft $av_pending = 'E'; 12356c72ffaaSAndy Whitcroft $type = 'N'; 12366c72ffaaSAndy Whitcroft 12371f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 12381f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 12391f65f947SAndy Whitcroft $av_pend_colon = 'C'; 12401f65f947SAndy Whitcroft $type = 'N'; 12411f65f947SAndy Whitcroft 124214b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1243c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 12446c72ffaaSAndy Whitcroft $type = 'N'; 12456c72ffaaSAndy Whitcroft 12466c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1247c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1248cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1249cf655043SAndy Whitcroft $av_pending = '_'; 12506c72ffaaSAndy Whitcroft $type = 'N'; 12516c72ffaaSAndy Whitcroft 12526c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1253cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1254cf655043SAndy Whitcroft if ($new_type ne '_') { 1255cf655043SAndy Whitcroft $type = $new_type; 1256c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1257c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 12586c72ffaaSAndy Whitcroft } else { 1259c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 12606c72ffaaSAndy Whitcroft } 12616c72ffaaSAndy Whitcroft 1262c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1263c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1264c8cb2ca3SAndy Whitcroft $type = 'V'; 1265cf655043SAndy Whitcroft $av_pending = 'V'; 12666c72ffaaSAndy Whitcroft 12678e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 12688e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 12691f65f947SAndy Whitcroft $av_pend_colon = 'B'; 12708e761b04SAndy Whitcroft } elsif ($type eq 'E') { 12718e761b04SAndy Whitcroft $av_pend_colon = 'L'; 12721f65f947SAndy Whitcroft } 12731f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 12741f65f947SAndy Whitcroft $type = 'V'; 12751f65f947SAndy Whitcroft 12766c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1277c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 12786c72ffaaSAndy Whitcroft $type = 'V'; 12796c72ffaaSAndy Whitcroft 12806c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1281c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 12826c72ffaaSAndy Whitcroft $type = 'N'; 12836c72ffaaSAndy Whitcroft 1284cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1285c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 128613214adfSAndy Whitcroft $type = 'E'; 12871f65f947SAndy Whitcroft $av_pend_colon = 'O'; 128813214adfSAndy Whitcroft 12898e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 12908e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 12918e761b04SAndy Whitcroft $type = 'C'; 12928e761b04SAndy Whitcroft 12931f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 12941f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 12951f65f947SAndy Whitcroft $type = 'N'; 12961f65f947SAndy Whitcroft 12971f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 12981f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 12991f65f947SAndy Whitcroft 13001f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 13011f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 13021f65f947SAndy Whitcroft $type = 'E'; 13031f65f947SAndy Whitcroft } else { 13041f65f947SAndy Whitcroft $type = 'N'; 13051f65f947SAndy Whitcroft } 13061f65f947SAndy Whitcroft $av_pend_colon = 'O'; 13071f65f947SAndy Whitcroft 13088e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 130913214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 13106c72ffaaSAndy Whitcroft $type = 'N'; 13116c72ffaaSAndy Whitcroft 13120d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 131374048ed8SAndy Whitcroft my $variant; 131474048ed8SAndy Whitcroft 131574048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 131674048ed8SAndy Whitcroft if ($type eq 'V') { 131774048ed8SAndy Whitcroft $variant = 'B'; 131874048ed8SAndy Whitcroft } else { 131974048ed8SAndy Whitcroft $variant = 'U'; 132074048ed8SAndy Whitcroft } 132174048ed8SAndy Whitcroft 132274048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 132374048ed8SAndy Whitcroft $type = 'N'; 132474048ed8SAndy Whitcroft 13256c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1326c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 13276c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 13286c72ffaaSAndy Whitcroft $type = 'N'; 13296c72ffaaSAndy Whitcroft } 13306c72ffaaSAndy Whitcroft 13316c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1332c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 13336c72ffaaSAndy Whitcroft } 13346c72ffaaSAndy Whitcroft if (defined $1) { 13356c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 13366c72ffaaSAndy Whitcroft $res .= $type x length($1); 13376c72ffaaSAndy Whitcroft } 13386c72ffaaSAndy Whitcroft } 13396c72ffaaSAndy Whitcroft 13401f65f947SAndy Whitcroft return ($res, $var); 13416c72ffaaSAndy Whitcroft} 13426c72ffaaSAndy Whitcroft 13438905a67cSAndy Whitcroftsub possible { 134413214adfSAndy Whitcroft my ($possible, $line) = @_; 13459a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 13460776e594SAndy Whitcroft ^(?: 13470776e594SAndy Whitcroft $Modifier| 13480776e594SAndy Whitcroft $Storage| 13490776e594SAndy Whitcroft $Type| 13509a974fdbSAndy Whitcroft DEFINE_\S+ 13519a974fdbSAndy Whitcroft )$| 13529a974fdbSAndy Whitcroft ^(?: 13530776e594SAndy Whitcroft goto| 13540776e594SAndy Whitcroft return| 13550776e594SAndy Whitcroft case| 13560776e594SAndy Whitcroft else| 13570776e594SAndy Whitcroft asm|__asm__| 135889a88353SAndy Whitcroft do| 135989a88353SAndy Whitcroft \#| 136089a88353SAndy Whitcroft \#\#| 13619a974fdbSAndy Whitcroft )(?:\s|$)| 13620776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 13639a974fdbSAndy Whitcroft )}x; 13649a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 13659a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1366c45dcabdSAndy Whitcroft # Check for modifiers. 1367c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1368c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1369c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1370c45dcabdSAndy Whitcroft 1371c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1372c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1373d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 13749a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1375d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1376d2506586SAndy Whitcroft push(@modifierList, $modifier); 1377d2506586SAndy Whitcroft } 13789a974fdbSAndy Whitcroft } 1379c45dcabdSAndy Whitcroft 1380c45dcabdSAndy Whitcroft } else { 138113214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 13828905a67cSAndy Whitcroft push(@typeList, $possible); 1383c45dcabdSAndy Whitcroft } 13848905a67cSAndy Whitcroft build_types(); 13850776e594SAndy Whitcroft } else { 13860776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 13878905a67cSAndy Whitcroft } 13888905a67cSAndy Whitcroft} 13898905a67cSAndy Whitcroft 13906c72ffaaSAndy Whitcroftmy $prefix = ''; 13916c72ffaaSAndy Whitcroft 1392000d1cc1SJoe Perchessub show_type { 1393*91bfe484SJoe Perches return defined $use_type{$_[0]} if (scalar keys %use_type > 0); 1394*91bfe484SJoe Perches 1395000d1cc1SJoe Perches return !defined $ignore_type{$_[0]}; 1396000d1cc1SJoe Perches} 1397000d1cc1SJoe Perches 1398f0a594c1SAndy Whitcroftsub report { 1399000d1cc1SJoe Perches if (!show_type($_[1]) || 1400000d1cc1SJoe Perches (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) { 1401773647a0SAndy Whitcroft return 0; 1402773647a0SAndy Whitcroft } 1403000d1cc1SJoe Perches my $line; 1404000d1cc1SJoe Perches if ($show_types) { 1405000d1cc1SJoe Perches $line = "$prefix$_[0]:$_[1]: $_[2]\n"; 1406000d1cc1SJoe Perches } else { 1407000d1cc1SJoe Perches $line = "$prefix$_[0]: $_[2]\n"; 1408000d1cc1SJoe Perches } 14098905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 14108905a67cSAndy Whitcroft 141113214adfSAndy Whitcroft push(our @report, $line); 1412773647a0SAndy Whitcroft 1413773647a0SAndy Whitcroft return 1; 1414f0a594c1SAndy Whitcroft} 1415f0a594c1SAndy Whitcroftsub report_dump { 141613214adfSAndy Whitcroft our @report; 1417f0a594c1SAndy Whitcroft} 1418000d1cc1SJoe Perches 1419de7d4f0eSAndy Whitcroftsub ERROR { 1420000d1cc1SJoe Perches if (report("ERROR", $_[0], $_[1])) { 1421de7d4f0eSAndy Whitcroft our $clean = 0; 14226c72ffaaSAndy Whitcroft our $cnt_error++; 14233705ce5bSJoe Perches return 1; 1424de7d4f0eSAndy Whitcroft } 14253705ce5bSJoe Perches return 0; 1426773647a0SAndy Whitcroft} 1427de7d4f0eSAndy Whitcroftsub WARN { 1428000d1cc1SJoe Perches if (report("WARNING", $_[0], $_[1])) { 1429de7d4f0eSAndy Whitcroft our $clean = 0; 14306c72ffaaSAndy Whitcroft our $cnt_warn++; 14313705ce5bSJoe Perches return 1; 1432de7d4f0eSAndy Whitcroft } 14333705ce5bSJoe Perches return 0; 1434773647a0SAndy Whitcroft} 1435de7d4f0eSAndy Whitcroftsub CHK { 1436000d1cc1SJoe Perches if ($check && report("CHECK", $_[0], $_[1])) { 1437de7d4f0eSAndy Whitcroft our $clean = 0; 14386c72ffaaSAndy Whitcroft our $cnt_chk++; 14393705ce5bSJoe Perches return 1; 14406c72ffaaSAndy Whitcroft } 14413705ce5bSJoe Perches return 0; 1442de7d4f0eSAndy Whitcroft} 1443de7d4f0eSAndy Whitcroft 14446ecd9674SAndy Whitcroftsub check_absolute_file { 14456ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 14466ecd9674SAndy Whitcroft my $file = $absolute; 14476ecd9674SAndy Whitcroft 14486ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 14496ecd9674SAndy Whitcroft 14506ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 14516ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 14526ecd9674SAndy Whitcroft if (-f "$root/$file") { 14536ecd9674SAndy Whitcroft ##print "file<$file>\n"; 14546ecd9674SAndy Whitcroft last; 14556ecd9674SAndy Whitcroft } 14566ecd9674SAndy Whitcroft } 14576ecd9674SAndy Whitcroft if (! -f _) { 14586ecd9674SAndy Whitcroft return 0; 14596ecd9674SAndy Whitcroft } 14606ecd9674SAndy Whitcroft 14616ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 14626ecd9674SAndy Whitcroft my $prefix = $absolute; 14636ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 14646ecd9674SAndy Whitcroft 14656ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 14666ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1467000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1468000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 14696ecd9674SAndy Whitcroft } 14706ecd9674SAndy Whitcroft} 14716ecd9674SAndy Whitcroft 14723705ce5bSJoe Perchessub trim { 14733705ce5bSJoe Perches my ($string) = @_; 14743705ce5bSJoe Perches 14753705ce5bSJoe Perches $string =~ s/(^\s+|\s+$)//g; 14763705ce5bSJoe Perches 14773705ce5bSJoe Perches return $string; 14783705ce5bSJoe Perches} 14793705ce5bSJoe Perches 14803705ce5bSJoe Perchessub tabify { 14813705ce5bSJoe Perches my ($leading) = @_; 14823705ce5bSJoe Perches 14833705ce5bSJoe Perches my $source_indent = 8; 14843705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 14853705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 14863705ce5bSJoe Perches 14873705ce5bSJoe Perches #convert leading spaces to tabs 14883705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 14893705ce5bSJoe Perches #Remove spaces before a tab 14903705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 14913705ce5bSJoe Perches 14923705ce5bSJoe Perches return "$leading"; 14933705ce5bSJoe Perches} 14943705ce5bSJoe Perches 1495d1fe9c09SJoe Perchessub pos_last_openparen { 1496d1fe9c09SJoe Perches my ($line) = @_; 1497d1fe9c09SJoe Perches 1498d1fe9c09SJoe Perches my $pos = 0; 1499d1fe9c09SJoe Perches 1500d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1501d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1502d1fe9c09SJoe Perches 1503d1fe9c09SJoe Perches my $last_openparen = 0; 1504d1fe9c09SJoe Perches 1505d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1506d1fe9c09SJoe Perches return -1; 1507d1fe9c09SJoe Perches } 1508d1fe9c09SJoe Perches 1509d1fe9c09SJoe Perches my $len = length($line); 1510d1fe9c09SJoe Perches 1511d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1512d1fe9c09SJoe Perches my $string = substr($line, $pos); 1513d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1514d1fe9c09SJoe Perches $pos += length($1) - 1; 1515d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1516d1fe9c09SJoe Perches $last_openparen = $pos; 1517d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1518d1fe9c09SJoe Perches last; 1519d1fe9c09SJoe Perches } 1520d1fe9c09SJoe Perches } 1521d1fe9c09SJoe Perches 1522d1fe9c09SJoe Perches return $last_openparen + 1; 1523d1fe9c09SJoe Perches} 1524d1fe9c09SJoe Perches 15250a920b5bSAndy Whitcroftsub process { 15260a920b5bSAndy Whitcroft my $filename = shift; 15270a920b5bSAndy Whitcroft 15280a920b5bSAndy Whitcroft my $linenr=0; 15290a920b5bSAndy Whitcroft my $prevline=""; 1530c2fdda0dSAndy Whitcroft my $prevrawline=""; 15310a920b5bSAndy Whitcroft my $stashline=""; 1532c2fdda0dSAndy Whitcroft my $stashrawline=""; 15330a920b5bSAndy Whitcroft 15344a0df2efSAndy Whitcroft my $length; 15350a920b5bSAndy Whitcroft my $indent; 15360a920b5bSAndy Whitcroft my $previndent=0; 15370a920b5bSAndy Whitcroft my $stashindent=0; 15380a920b5bSAndy Whitcroft 1539de7d4f0eSAndy Whitcroft our $clean = 1; 15400a920b5bSAndy Whitcroft my $signoff = 0; 15410a920b5bSAndy Whitcroft my $is_patch = 0; 15420a920b5bSAndy Whitcroft 154315662b3eSJoe Perches my $in_header_lines = 1; 154415662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 154515662b3eSJoe Perches 1546fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1547fa64205dSPasi Savanainen 154813214adfSAndy Whitcroft our @report = (); 15496c72ffaaSAndy Whitcroft our $cnt_lines = 0; 15506c72ffaaSAndy Whitcroft our $cnt_error = 0; 15516c72ffaaSAndy Whitcroft our $cnt_warn = 0; 15526c72ffaaSAndy Whitcroft our $cnt_chk = 0; 15536c72ffaaSAndy Whitcroft 15540a920b5bSAndy Whitcroft # Trace the real file/line as we go. 15550a920b5bSAndy Whitcroft my $realfile = ''; 15560a920b5bSAndy Whitcroft my $realline = 0; 15570a920b5bSAndy Whitcroft my $realcnt = 0; 15580a920b5bSAndy Whitcroft my $here = ''; 15590a920b5bSAndy Whitcroft my $in_comment = 0; 1560c2fdda0dSAndy Whitcroft my $comment_edge = 0; 15610a920b5bSAndy Whitcroft my $first_line = 0; 15621e855726SWolfram Sang my $p1_prefix = ''; 15630a920b5bSAndy Whitcroft 156413214adfSAndy Whitcroft my $prev_values = 'E'; 156513214adfSAndy Whitcroft 156613214adfSAndy Whitcroft # suppression flags 1567773647a0SAndy Whitcroft my %suppress_ifbraces; 1568170d3a22SAndy Whitcroft my %suppress_whiletrailers; 15692b474a1aSAndy Whitcroft my %suppress_export; 15703e469cdcSAndy Whitcroft my $suppress_statement = 0; 1571653d4876SAndy Whitcroft 15727e51f197SJoe Perches my %signatures = (); 1573323c1260SJoe Perches 1574c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1575de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1576c2fdda0dSAndy Whitcroft # 1577de7d4f0eSAndy Whitcroft my @setup_docs = (); 1578de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1579773647a0SAndy Whitcroft 1580773647a0SAndy Whitcroft sanitise_line_reset(); 1581c2fdda0dSAndy Whitcroft my $line; 1582c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1583773647a0SAndy Whitcroft $linenr++; 1584773647a0SAndy Whitcroft $line = $rawline; 1585c2fdda0dSAndy Whitcroft 15863705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 15873705ce5bSJoe Perches 1588773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1589de7d4f0eSAndy Whitcroft $setup_docs = 0; 1590de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1591de7d4f0eSAndy Whitcroft $setup_docs = 1; 1592de7d4f0eSAndy Whitcroft } 1593773647a0SAndy Whitcroft #next; 1594de7d4f0eSAndy Whitcroft } 1595773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1596773647a0SAndy Whitcroft $realline=$1-1; 1597773647a0SAndy Whitcroft if (defined $2) { 1598773647a0SAndy Whitcroft $realcnt=$3+1; 1599773647a0SAndy Whitcroft } else { 1600773647a0SAndy Whitcroft $realcnt=1+1; 1601773647a0SAndy Whitcroft } 1602c45dcabdSAndy Whitcroft $in_comment = 0; 1603773647a0SAndy Whitcroft 1604773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1605773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1606773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1607773647a0SAndy Whitcroft # at context start. 1608773647a0SAndy Whitcroft my $edge; 160901fa9147SAndy Whitcroft my $cnt = $realcnt; 161001fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 161101fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 161201fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 161301fa9147SAndy Whitcroft $cnt--; 161401fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1615721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1616fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1617fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1618fae17daeSAndy Whitcroft ($edge) = $1; 1619fae17daeSAndy Whitcroft last; 1620fae17daeSAndy Whitcroft } 1621773647a0SAndy Whitcroft } 1622773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1623773647a0SAndy Whitcroft $in_comment = 1; 1624773647a0SAndy Whitcroft } 1625773647a0SAndy Whitcroft 1626773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1627773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1628773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1629773647a0SAndy Whitcroft if (!defined $edge && 163083242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1631773647a0SAndy Whitcroft { 1632773647a0SAndy Whitcroft $in_comment = 1; 1633773647a0SAndy Whitcroft } 1634773647a0SAndy Whitcroft 1635773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1636773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1637773647a0SAndy Whitcroft 1638171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1639773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1640171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1641773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1642773647a0SAndy Whitcroft } 1643773647a0SAndy Whitcroft push(@lines, $line); 1644773647a0SAndy Whitcroft 1645773647a0SAndy Whitcroft if ($realcnt > 1) { 1646773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1647773647a0SAndy Whitcroft } else { 1648773647a0SAndy Whitcroft $realcnt = 0; 1649773647a0SAndy Whitcroft } 1650773647a0SAndy Whitcroft 1651773647a0SAndy Whitcroft #print "==>$rawline\n"; 1652773647a0SAndy Whitcroft #print "-->$line\n"; 1653de7d4f0eSAndy Whitcroft 1654de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1655de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1656de7d4f0eSAndy Whitcroft } 1657de7d4f0eSAndy Whitcroft } 1658de7d4f0eSAndy Whitcroft 16596c72ffaaSAndy Whitcroft $prefix = ''; 16606c72ffaaSAndy Whitcroft 1661773647a0SAndy Whitcroft $realcnt = 0; 1662773647a0SAndy Whitcroft $linenr = 0; 16630a920b5bSAndy Whitcroft foreach my $line (@lines) { 16640a920b5bSAndy Whitcroft $linenr++; 16650a920b5bSAndy Whitcroft 1666c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 16676c72ffaaSAndy Whitcroft 16680a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 16696c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 16700a920b5bSAndy Whitcroft $is_patch = 1; 16714a0df2efSAndy Whitcroft $first_line = $linenr + 1; 16720a920b5bSAndy Whitcroft $realline=$1-1; 16730a920b5bSAndy Whitcroft if (defined $2) { 16740a920b5bSAndy Whitcroft $realcnt=$3+1; 16750a920b5bSAndy Whitcroft } else { 16760a920b5bSAndy Whitcroft $realcnt=1+1; 16770a920b5bSAndy Whitcroft } 1678c2fdda0dSAndy Whitcroft annotate_reset(); 167913214adfSAndy Whitcroft $prev_values = 'E'; 168013214adfSAndy Whitcroft 1681773647a0SAndy Whitcroft %suppress_ifbraces = (); 1682170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 16832b474a1aSAndy Whitcroft %suppress_export = (); 16843e469cdcSAndy Whitcroft $suppress_statement = 0; 16850a920b5bSAndy Whitcroft next; 16860a920b5bSAndy Whitcroft 16874a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 16884a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 16894a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1690773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 16910a920b5bSAndy Whitcroft $realline++; 1692d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 16930a920b5bSAndy Whitcroft 16944a0df2efSAndy Whitcroft # Measure the line length and indent. 1695c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 16960a920b5bSAndy Whitcroft 16970a920b5bSAndy Whitcroft # Track the previous line. 16980a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 16990a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1700c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1701c2fdda0dSAndy Whitcroft 1702773647a0SAndy Whitcroft #warn "line<$line>\n"; 17036c72ffaaSAndy Whitcroft 1704d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1705d8aaf121SAndy Whitcroft $realcnt--; 17060a920b5bSAndy Whitcroft } 17070a920b5bSAndy Whitcroft 1708cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 1709cc77cdcaSAndy Whitcroft 17100a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1711773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1712773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1713773647a0SAndy Whitcroft 17146c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 17156c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1716773647a0SAndy Whitcroft 1717773647a0SAndy Whitcroft # extract the filename as it passes 17183bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 17193bf9a009SRabin Vincent $realfile = $1; 17203bf9a009SRabin Vincent $realfile =~ s@^([^/]*)/@@; 1721270c49a0SJoe Perches $in_commit_log = 0; 17223bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 1723773647a0SAndy Whitcroft $realfile = $1; 17241e855726SWolfram Sang $realfile =~ s@^([^/]*)/@@; 1725270c49a0SJoe Perches $in_commit_log = 0; 17261e855726SWolfram Sang 17271e855726SWolfram Sang $p1_prefix = $1; 1728e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 1729e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 1730000d1cc1SJoe Perches WARN("PATCH_PREFIX", 1731000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 17321e855726SWolfram Sang } 1733773647a0SAndy Whitcroft 1734c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 1735000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 1736000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1737773647a0SAndy Whitcroft } 1738773647a0SAndy Whitcroft next; 1739773647a0SAndy Whitcroft } 1740773647a0SAndy Whitcroft 1741389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 17420a920b5bSAndy Whitcroft 1743c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1744c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1745c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 17460a920b5bSAndy Whitcroft 17476c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 17486c72ffaaSAndy Whitcroft 17493bf9a009SRabin Vincent# Check for incorrect file permissions 17503bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 17513bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 175204db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 175304db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 1754000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 1755000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 17563bf9a009SRabin Vincent } 17573bf9a009SRabin Vincent } 17583bf9a009SRabin Vincent 175920112475SJoe Perches# Check the patch for a signoff: 1760d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 17614a0df2efSAndy Whitcroft $signoff++; 176215662b3eSJoe Perches $in_commit_log = 0; 17630a920b5bSAndy Whitcroft } 176420112475SJoe Perches 176520112475SJoe Perches# Check signature styles 1766270c49a0SJoe Perches if (!$in_header_lines && 1767ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 176820112475SJoe Perches my $space_before = $1; 176920112475SJoe Perches my $sign_off = $2; 177020112475SJoe Perches my $space_after = $3; 177120112475SJoe Perches my $email = $4; 177220112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 177320112475SJoe Perches 1774ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 1775ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 1776ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 1777ce0338dfSJoe Perches } 177820112475SJoe Perches if (defined $space_before && $space_before ne "") { 17793705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 17803705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 17813705ce5bSJoe Perches $fix) { 17823705ce5bSJoe Perches $fixed[$linenr - 1] = 17833705ce5bSJoe Perches "$ucfirst_sign_off $email"; 17843705ce5bSJoe Perches } 178520112475SJoe Perches } 178620112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 17873705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 17883705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 17893705ce5bSJoe Perches $fix) { 17903705ce5bSJoe Perches $fixed[$linenr - 1] = 17913705ce5bSJoe Perches "$ucfirst_sign_off $email"; 17923705ce5bSJoe Perches } 17933705ce5bSJoe Perches 179420112475SJoe Perches } 179520112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 17963705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 17973705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 17983705ce5bSJoe Perches $fix) { 17993705ce5bSJoe Perches $fixed[$linenr - 1] = 18003705ce5bSJoe Perches "$ucfirst_sign_off $email"; 18013705ce5bSJoe Perches } 180220112475SJoe Perches } 180320112475SJoe Perches 180420112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 180520112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 180620112475SJoe Perches if ($suggested_email eq "") { 1807000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 1808000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 180920112475SJoe Perches } else { 181020112475SJoe Perches my $dequoted = $suggested_email; 181120112475SJoe Perches $dequoted =~ s/^"//; 181220112475SJoe Perches $dequoted =~ s/" </ </; 181320112475SJoe Perches # Don't force email to have quotes 181420112475SJoe Perches # Allow just an angle bracketed address 181520112475SJoe Perches if ("$dequoted$comment" ne $email && 181620112475SJoe Perches "<$email_address>$comment" ne $email && 181720112475SJoe Perches "$suggested_email$comment" ne $email) { 1818000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1819000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 182020112475SJoe Perches } 18210a920b5bSAndy Whitcroft } 18227e51f197SJoe Perches 18237e51f197SJoe Perches# Check for duplicate signatures 18247e51f197SJoe Perches my $sig_nospace = $line; 18257e51f197SJoe Perches $sig_nospace =~ s/\s//g; 18267e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 18277e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 18287e51f197SJoe Perches WARN("BAD_SIGN_OFF", 18297e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 18307e51f197SJoe Perches } else { 18317e51f197SJoe Perches $signatures{$sig_nospace} = 1; 18327e51f197SJoe Perches } 18330a920b5bSAndy Whitcroft } 18340a920b5bSAndy Whitcroft 183500df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 18368905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1837000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 1838000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 18396c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 1840de7d4f0eSAndy Whitcroft } 1841de7d4f0eSAndy Whitcroft 18426ecd9674SAndy Whitcroft# Check for absolute kernel paths. 18436ecd9674SAndy Whitcroft if ($tree) { 18446ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 18456ecd9674SAndy Whitcroft my $file = $1; 18466ecd9674SAndy Whitcroft 18476ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 18486ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 18496ecd9674SAndy Whitcroft # 18506ecd9674SAndy Whitcroft } else { 18516ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 18526ecd9674SAndy Whitcroft } 18536ecd9674SAndy Whitcroft } 18546ecd9674SAndy Whitcroft } 18556ecd9674SAndy Whitcroft 1856de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1857de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 1858171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 1859171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1860171ae1a4SAndy Whitcroft 1861171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 1862171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1863171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 1864171ae1a4SAndy Whitcroft 186534d99219SJoe Perches CHK("INVALID_UTF8", 1866000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 186700df344fSAndy Whitcroft } 18680a920b5bSAndy Whitcroft 186915662b3eSJoe Perches# Check if it's the start of a commit log 187015662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 187115662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 1872270c49a0SJoe Perches $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) { 187315662b3eSJoe Perches $in_header_lines = 0; 187415662b3eSJoe Perches $in_commit_log = 1; 187515662b3eSJoe Perches } 187615662b3eSJoe Perches 1877fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 1878fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 1879fa64205dSPasi Savanainen if ($in_header_lines && 1880fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 1881fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 1882fa64205dSPasi Savanainen $non_utf8_charset = 1; 1883fa64205dSPasi Savanainen } 1884fa64205dSPasi Savanainen 1885fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 188615662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 1887fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 188815662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 188915662b3eSJoe Perches } 189015662b3eSJoe Perches 189130670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 189230670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 189300df344fSAndy Whitcroft 18940a920b5bSAndy Whitcroft#trailing whitespace 18959c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 1896c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1897d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 1898d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 1899d5e616fcSJoe Perches $fix) { 1900d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/[\s\015]+$//; 1901d5e616fcSJoe Perches } 1902c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 1903c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 19043705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 19053705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 19063705ce5bSJoe Perches $fix) { 1907d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\s+$//; 19083705ce5bSJoe Perches } 19093705ce5bSJoe Perches 1910d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 19110a920b5bSAndy Whitcroft } 19125368df20SAndy Whitcroft 19133354957aSAndi Kleen# check for Kconfig help text having a real description 19149fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 19159fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 19163354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 1917a1385803SAndy Whitcroft $line =~ /.\s*config\s+/) { 19183354957aSAndi Kleen my $length = 0; 19199fe287d7SAndy Whitcroft my $cnt = $realcnt; 19209fe287d7SAndy Whitcroft my $ln = $linenr + 1; 19219fe287d7SAndy Whitcroft my $f; 1922a1385803SAndy Whitcroft my $is_start = 0; 19239fe287d7SAndy Whitcroft my $is_end = 0; 1924a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 19259fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 19269fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 19279fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 19289fe287d7SAndy Whitcroft 19299fe287d7SAndy Whitcroft next if ($f =~ /^-/); 1930a1385803SAndy Whitcroft 1931a1385803SAndy Whitcroft if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) { 1932a1385803SAndy Whitcroft $is_start = 1; 1933a1385803SAndy Whitcroft } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) { 1934a1385803SAndy Whitcroft $length = -1; 1935a1385803SAndy Whitcroft } 1936a1385803SAndy Whitcroft 19379fe287d7SAndy Whitcroft $f =~ s/^.//; 19383354957aSAndi Kleen $f =~ s/#.*//; 19393354957aSAndi Kleen $f =~ s/^\s+//; 19403354957aSAndi Kleen next if ($f =~ /^$/); 19419fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 19429fe287d7SAndy Whitcroft $is_end = 1; 19439fe287d7SAndy Whitcroft last; 19449fe287d7SAndy Whitcroft } 19453354957aSAndi Kleen $length++; 19463354957aSAndi Kleen } 1947000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 1948a1385803SAndy Whitcroft "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4); 1949a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 19503354957aSAndi Kleen } 19513354957aSAndi Kleen 19521ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 19531ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 19541ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 19551ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 19561ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 19571ba8dfd1SKees Cook } 19581ba8dfd1SKees Cook 1959c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 1960c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 1961c68e5878SArnaud Lacombe my $flag = $1; 1962c68e5878SArnaud Lacombe my $replacement = { 1963c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 1964c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 1965c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 1966c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 1967c68e5878SArnaud Lacombe }; 1968c68e5878SArnaud Lacombe 1969c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 1970c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 1971c68e5878SArnaud Lacombe } 1972c68e5878SArnaud Lacombe 19735368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 19745368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 19755368df20SAndy Whitcroft 19766cd7f386SJoe Perches#line length limit 1977c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 1978f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 19790fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 19808bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 19816cd7f386SJoe Perches $length > $max_line_length) 1982c45dcabdSAndy Whitcroft { 1983000d1cc1SJoe Perches WARN("LONG_LINE", 19846cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 19850a920b5bSAndy Whitcroft } 19860a920b5bSAndy Whitcroft 1987ca56dc09SJosh Triplett# Check for user-visible strings broken across lines, which breaks the ability 1988ca56dc09SJosh Triplett# to grep for the string. Limited to strings used as parameters (those 1989ca56dc09SJosh Triplett# following an open parenthesis), which almost completely eliminates false 1990ca56dc09SJosh Triplett# positives, as well as warning only once per parameter rather than once per 1991ca56dc09SJosh Triplett# line of the string. Make an exception when the previous string ends in a 1992ca56dc09SJosh Triplett# newline (multiple lines in one string constant) or \n\t (common in inline 1993ca56dc09SJosh Triplett# assembly to indent the instruction on the following line). 1994ca56dc09SJosh Triplett if ($line =~ /^\+\s*"/ && 1995ca56dc09SJosh Triplett $prevline =~ /"\s*$/ && 1996ca56dc09SJosh Triplett $prevline =~ /\(/ && 1997ca56dc09SJosh Triplett $prevrawline !~ /\\n(?:\\t)*"\s*$/) { 1998ca56dc09SJosh Triplett WARN("SPLIT_STRING", 1999ca56dc09SJosh Triplett "quoted string split across lines\n" . $hereprev); 2000ca56dc09SJosh Triplett } 2001ca56dc09SJosh Triplett 20025e79d96eSJoe Perches# check for spaces before a quoted newline 20035e79d96eSJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 20043705ce5bSJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 20053705ce5bSJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 20063705ce5bSJoe Perches $fix) { 20073705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 20083705ce5bSJoe Perches } 20093705ce5bSJoe Perches 20105e79d96eSJoe Perches } 20115e79d96eSJoe Perches 20128905a67cSAndy Whitcroft# check for adding lines without a newline. 20138905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2014000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2015000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 20168905a67cSAndy Whitcroft } 20178905a67cSAndy Whitcroft 201842e41c54SMike Frysinger# Blackfin: use hi/lo macros 201942e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 202042e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 202142e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2022000d1cc1SJoe Perches ERROR("LO_MACRO", 2023000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 202442e41c54SMike Frysinger } 202542e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 202642e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2027000d1cc1SJoe Perches ERROR("HI_MACRO", 2028000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 202942e41c54SMike Frysinger } 203042e41c54SMike Frysinger } 203142e41c54SMike Frysinger 2032b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2033b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 20340a920b5bSAndy Whitcroft 20350a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 20360a920b5bSAndy Whitcroft# more than 8 must use tabs. 2037c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2038c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2039c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2040d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 20413705ce5bSJoe Perches if (ERROR("CODE_INDENT", 20423705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 20433705ce5bSJoe Perches $fix) { 20443705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 20453705ce5bSJoe Perches } 20460a920b5bSAndy Whitcroft } 20470a920b5bSAndy Whitcroft 204808e44365SAlberto Panizzo# check for space before tabs. 204908e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 205008e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 20513705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 20523705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 20533705ce5bSJoe Perches $fix) { 20543705ce5bSJoe Perches $fixed[$linenr - 1] =~ 20553705ce5bSJoe Perches s/(^\+.*) +\t/$1\t/; 20563705ce5bSJoe Perches } 205708e44365SAlberto Panizzo } 205808e44365SAlberto Panizzo 2059d1fe9c09SJoe Perches# check for && or || at the start of a line 2060d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2061d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2062d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2063d1fe9c09SJoe Perches } 2064d1fe9c09SJoe Perches 2065d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2066d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 2067d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) { 2068d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2069d1fe9c09SJoe Perches my $oldindent = $1; 2070d1fe9c09SJoe Perches my $rest = $2; 2071d1fe9c09SJoe Perches 2072d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2073d1fe9c09SJoe Perches if ($pos >= 0) { 2074b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2075b34a26f3SJoe Perches my $newindent = $2; 2076d1fe9c09SJoe Perches 2077d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2078d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2079d1fe9c09SJoe Perches " " x ($pos % 8); 2080d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2081d1fe9c09SJoe Perches 2082d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2083d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 20843705ce5bSJoe Perches 20853705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 20863705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 20873705ce5bSJoe Perches $fix && $line =~ /^\+/) { 20883705ce5bSJoe Perches $fixed[$linenr - 1] =~ 20893705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 20903705ce5bSJoe Perches } 2091d1fe9c09SJoe Perches } 2092d1fe9c09SJoe Perches } 2093d1fe9c09SJoe Perches } 2094d1fe9c09SJoe Perches 209523f780c9SJoe Perches if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) { 20963705ce5bSJoe Perches if (CHK("SPACING", 20973705ce5bSJoe Perches "No space is necessary after a cast\n" . $hereprev) && 20983705ce5bSJoe Perches $fix) { 20993705ce5bSJoe Perches $fixed[$linenr - 1] =~ 21003705ce5bSJoe Perches s/^(\+.*\*[ \t]*\))[ \t]+/$1/; 21013705ce5bSJoe Perches } 2102aad4f614SJoe Perches } 2103aad4f614SJoe Perches 210405880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2105fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 2106fdb4bcd6SJoe Perches $rawline =~ /^\+[ \t]*\*/) { 210705880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 210805880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 210905880600SJoe Perches } 211005880600SJoe Perches 211105880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2112a605e32eSJoe Perches $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /* 2113a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 211461135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2115a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 2116a605e32eSJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 2117a605e32eSJoe Perches "networking block comments start with * on subsequent lines\n" . $hereprev); 2118a605e32eSJoe Perches } 2119a605e32eSJoe Perches 2120a605e32eSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2121c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2122c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2123c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2124c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 212505880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 212605880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 212705880600SJoe Perches } 212805880600SJoe Perches 21295f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 21306b4c5bebSAndy Whitcroft# Exceptions: 21316b4c5bebSAndy Whitcroft# 1) within comments 21326b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 21336b4c5bebSAndy Whitcroft# 3) hanging labels 21343705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 21355f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 21363705ce5bSJoe Perches if (WARN("LEADING_SPACE", 21373705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 21383705ce5bSJoe Perches $fix) { 21393705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 21403705ce5bSJoe Perches } 21415f7ddae6SRaffaele Recalcati } 21425f7ddae6SRaffaele Recalcati 2143b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2144b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2145b9ea10d6SAndy Whitcroft 21461ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 21471ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 21481ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 21491ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 21501ba8dfd1SKees Cook } 21511ba8dfd1SKees Cook 2152c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2153cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2154000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2155000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2156c2fdda0dSAndy Whitcroft } 215722f2a2efSAndy Whitcroft 215842e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 215942e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 216042e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2161000d1cc1SJoe Perches ERROR("CSYNC", 2162000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 216342e41c54SMike Frysinger } 216442e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 216542e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2166000d1cc1SJoe Perches ERROR("SSYNC", 2167000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 216842e41c54SMike Frysinger } 216942e41c54SMike Frysinger 217056e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 217156e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 217256e77d70SJoe Perches WARN("HOTPLUG_SECTION", 217356e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 217456e77d70SJoe Perches } 217556e77d70SJoe Perches 21769c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 21772b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 21782b474a1aSAndy Whitcroft $realline_next); 21793e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 21803e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 21813e469cdcSAndy Whitcroft $realcnt && $line =~ /.\s*\S/) { 2182170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2183f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2184171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2185171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2186171ae1a4SAndy Whitcroft 21873e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 21883e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 21893e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 21903e469cdcSAndy Whitcroft # until we hit end of it. 21913e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 21923e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 21933e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 21943e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 21953e469cdcSAndy Whitcroft } 2196f74bd194SAndy Whitcroft 21972b474a1aSAndy Whitcroft # Find the real next line. 21982b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 21992b474a1aSAndy Whitcroft if (defined $realline_next && 22002b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 22012b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 22022b474a1aSAndy Whitcroft $realline_next++; 22032b474a1aSAndy Whitcroft } 22042b474a1aSAndy Whitcroft 2205171ae1a4SAndy Whitcroft my $s = $stat; 2206171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2207cf655043SAndy Whitcroft 2208c2fdda0dSAndy Whitcroft # Ignore goto labels. 2209171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2210c2fdda0dSAndy Whitcroft 2211c2fdda0dSAndy Whitcroft # Ignore functions being called 2212171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2213c2fdda0dSAndy Whitcroft 2214463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2215463f2864SAndy Whitcroft 2216c45dcabdSAndy Whitcroft # declarations always start with types 2217d2506586SAndy 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) { 2218c45dcabdSAndy Whitcroft my $type = $1; 2219c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2220c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2221c45dcabdSAndy Whitcroft 22226c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2223a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2224c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 2225c2fdda0dSAndy Whitcroft } 22268905a67cSAndy Whitcroft 22276c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 222865863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2229c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 22309c0ca6f9SAndy Whitcroft } 22318905a67cSAndy Whitcroft 22328905a67cSAndy Whitcroft # Check for any sort of function declaration. 22338905a67cSAndy Whitcroft # int foo(something bar, other baz); 22348905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2235171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 22368905a67cSAndy Whitcroft my ($name_len) = length($1); 22378905a67cSAndy Whitcroft 2238cf655043SAndy Whitcroft my $ctx = $s; 2239773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 22408905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2241cf655043SAndy Whitcroft 22428905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2243c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 22448905a67cSAndy Whitcroft 2245c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 22468905a67cSAndy Whitcroft } 22478905a67cSAndy Whitcroft } 22488905a67cSAndy Whitcroft } 22498905a67cSAndy Whitcroft 22509c0ca6f9SAndy Whitcroft } 22519c0ca6f9SAndy Whitcroft 225200df344fSAndy Whitcroft# 225300df344fSAndy Whitcroft# Checks which may be anchored in the context. 225400df344fSAndy Whitcroft# 225500df344fSAndy Whitcroft 225600df344fSAndy Whitcroft# Check for switch () and associated case and default 225700df344fSAndy Whitcroft# statements should be at the same indent. 225800df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 225900df344fSAndy Whitcroft my $err = ''; 226000df344fSAndy Whitcroft my $sep = ''; 226100df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 226200df344fSAndy Whitcroft shift(@ctx); 226300df344fSAndy Whitcroft for my $ctx (@ctx) { 226400df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 226500df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 226600df344fSAndy Whitcroft $indent != $cindent) { 226700df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 226800df344fSAndy Whitcroft $sep = ''; 226900df344fSAndy Whitcroft } else { 227000df344fSAndy Whitcroft $sep = "[...]\n"; 227100df344fSAndy Whitcroft } 227200df344fSAndy Whitcroft } 227300df344fSAndy Whitcroft if ($err ne '') { 2274000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2275000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2276de7d4f0eSAndy Whitcroft } 2277de7d4f0eSAndy Whitcroft } 2278de7d4f0eSAndy Whitcroft 2279de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2280de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 2281c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2282773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2283773647a0SAndy Whitcroft 22849c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 22858eef05ddSJoe Perches 22868eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 22878eef05ddSJoe Perches WARN("DEEP_INDENTATION", 22888eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 22898eef05ddSJoe Perches } 22908eef05ddSJoe Perches 2291de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2292de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2293de7d4f0eSAndy Whitcroft 2294548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2295548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2296de7d4f0eSAndy Whitcroft 2297548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2298548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2299548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2300548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2301548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2302773647a0SAndy Whitcroft $ctx_ln++; 2303773647a0SAndy Whitcroft } 2304548596d5SAndy Whitcroft 230553210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 230653210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2307773647a0SAndy Whitcroft 2308773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2309000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2310000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 231101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 231200df344fSAndy Whitcroft } 2313773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2314773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2315773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2316773647a0SAndy Whitcroft { 23179c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 23189c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2319000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2320000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 232101464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 23229c0ca6f9SAndy Whitcroft } 23239c0ca6f9SAndy Whitcroft } 232400df344fSAndy Whitcroft } 232500df344fSAndy Whitcroft 23264d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 23274d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 23283e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 23293e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 23303e469cdcSAndy Whitcroft if (!defined $stat); 23314d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 23324d001e4dSAndy Whitcroft 23334d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 23344d001e4dSAndy Whitcroft 23354d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 23364d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 23374d001e4dSAndy Whitcroft # where necessary. 23384d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 23394d001e4dSAndy Whitcroft 23404d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 23416f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 23426f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 23434d001e4dSAndy Whitcroft 23444d001e4dSAndy Whitcroft # We want to check the first line inside the block 23454d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 23464d001e4dSAndy Whitcroft # 1) any blank line termination 23474d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 23484d001e4dSAndy Whitcroft # 3) any do (...) { 23494d001e4dSAndy Whitcroft my $continuation = 0; 23504d001e4dSAndy Whitcroft my $check = 0; 23514d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 23524d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 23534d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 23544d001e4dSAndy Whitcroft $continuation = 1; 23554d001e4dSAndy Whitcroft } 23569bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 23574d001e4dSAndy Whitcroft $check = 1; 23584d001e4dSAndy Whitcroft $cond_lines++; 23594d001e4dSAndy Whitcroft } 23604d001e4dSAndy Whitcroft 23614d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 23624d001e4dSAndy Whitcroft # preprocessor statement. 23634d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 23644d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 23654d001e4dSAndy Whitcroft $check = 0; 23664d001e4dSAndy Whitcroft } 23674d001e4dSAndy Whitcroft 23689bd49efeSAndy Whitcroft my $cond_ptr = -1; 2369740504c6SAndy Whitcroft $continuation = 0; 23709bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 23719bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 23724d001e4dSAndy Whitcroft 2373f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2374f16fa28fSAndy Whitcroft # is not linear. 2375f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2376f16fa28fSAndy Whitcroft $check = 0; 2377f16fa28fSAndy Whitcroft } 2378f16fa28fSAndy Whitcroft 23799bd49efeSAndy Whitcroft # Ignore: 23809bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 23819bd49efeSAndy Whitcroft # 2) preprocessor lines, and 23829bd49efeSAndy Whitcroft # 3) labels. 2383740504c6SAndy Whitcroft if ($continuation || 2384740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 23859bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 23869bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 2387740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 238830dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 23899bd49efeSAndy Whitcroft $cond_lines++; 23909bd49efeSAndy Whitcroft } 23914d001e4dSAndy Whitcroft } 239230dad6ebSAndy Whitcroft } 23934d001e4dSAndy Whitcroft 23944d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 23954d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 23964d001e4dSAndy Whitcroft 23974d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 23984d001e4dSAndy Whitcroft # this is not this patch's fault. 23994d001e4dSAndy Whitcroft if (!defined($stat_real) || 24004d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 24014d001e4dSAndy Whitcroft $check = 0; 24024d001e4dSAndy Whitcroft } 24034d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 24044d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 24054d001e4dSAndy Whitcroft } 24064d001e4dSAndy Whitcroft 24079bd49efeSAndy 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"; 24084d001e4dSAndy Whitcroft 24094d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 24104d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 2411000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 2412000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 24134d001e4dSAndy Whitcroft } 24144d001e4dSAndy Whitcroft } 24154d001e4dSAndy Whitcroft 24166c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 24176c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 24181f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 24191f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 24206c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2421c2fdda0dSAndy Whitcroft if ($dbg_values) { 2422c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2423cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2424cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 24251f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2426c2fdda0dSAndy Whitcroft } 24276c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 24286c72ffaaSAndy Whitcroft 242900df344fSAndy Whitcroft#ignore lines not being added 24303705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 243100df344fSAndy Whitcroft 2432653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 24337429c690SAndy Whitcroft if ($dbg_type) { 24347429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2435000d1cc1SJoe Perches ERROR("TEST_TYPE", 2436000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 24377429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2438000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2439000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 24407429c690SAndy Whitcroft } 2441653d4876SAndy Whitcroft next; 2442653d4876SAndy Whitcroft } 2443a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2444a1ef277eSAndy Whitcroft if ($dbg_attr) { 24459360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2446000d1cc1SJoe Perches ERROR("TEST_ATTR", 2447000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 24489360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2449000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2450000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2451a1ef277eSAndy Whitcroft } 2452a1ef277eSAndy Whitcroft next; 2453a1ef277eSAndy Whitcroft } 2454653d4876SAndy Whitcroft 2455f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 245699423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 245799423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2458000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2459000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . $hereprev); 2460f0a594c1SAndy Whitcroft } 2461f0a594c1SAndy Whitcroft 246200df344fSAndy Whitcroft# 246300df344fSAndy Whitcroft# Checks which are anchored on the added line. 246400df344fSAndy Whitcroft# 246500df344fSAndy Whitcroft 2466653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 2467c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2468653d4876SAndy Whitcroft my $path = $1; 2469653d4876SAndy Whitcroft if ($path =~ m{//}) { 2470000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 2471495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 2472495e9d84SJoe Perches } 2473495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 2474495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 2475495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 2476653d4876SAndy Whitcroft } 2477653d4876SAndy Whitcroft } 2478653d4876SAndy Whitcroft 247900df344fSAndy Whitcroft# no C99 // comments 248000df344fSAndy Whitcroft if ($line =~ m{//}) { 24813705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 24823705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 24833705ce5bSJoe Perches $fix) { 24843705ce5bSJoe Perches my $line = $fixed[$linenr - 1]; 24853705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 24863705ce5bSJoe Perches my $comment = trim($1); 24873705ce5bSJoe Perches $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@; 24883705ce5bSJoe Perches } 24893705ce5bSJoe Perches } 249000df344fSAndy Whitcroft } 249100df344fSAndy Whitcroft # Remove C99 comments. 24920a920b5bSAndy Whitcroft $line =~ s@//.*@@; 24936c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 24940a920b5bSAndy Whitcroft 24952b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 24962b474a1aSAndy Whitcroft# the whole statement. 24972b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 24982b474a1aSAndy Whitcroft if (defined $realline_next && 24992b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 25002b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 25012b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 25022b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 25033cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 25043cbf62dfSAndy Whitcroft # a prefix: 25053cbf62dfSAndy Whitcroft # XXX(foo); 25063cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 2507653d4876SAndy Whitcroft my $name = $1; 250887a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 25093cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 25103cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 25113cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 25123cbf62dfSAndy Whitcroft 25133cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 25142b474a1aSAndy Whitcroft \n.}\s*$| 251548012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 251648012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 251748012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 25182b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 25192b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 252048012058SAndy Whitcroft )/x) { 25212b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 25222b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 25232b474a1aSAndy Whitcroft } else { 25242b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 25250a920b5bSAndy Whitcroft } 25260a920b5bSAndy Whitcroft } 25272b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 25282b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 25292b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 25302b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 25312b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 25322b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 25332b474a1aSAndy Whitcroft } 25342b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 25352b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 2536000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 2537000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 25382b474a1aSAndy Whitcroft } 25390a920b5bSAndy Whitcroft 25405150bda4SJoe Eloff# check for global initialisers. 2541d5e616fcSJoe Perches if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) { 2542d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 2543000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 2544d5e616fcSJoe Perches $herecurr) && 2545d5e616fcSJoe Perches $fix) { 2546d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/; 2547d5e616fcSJoe Perches } 2548f0a594c1SAndy Whitcroft } 25490a920b5bSAndy Whitcroft# check for static initialisers. 2550d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2551d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 2552000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 2553d5e616fcSJoe Perches $herecurr) && 2554d5e616fcSJoe Perches $fix) { 2555d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 2556d5e616fcSJoe Perches } 25570a920b5bSAndy Whitcroft } 25580a920b5bSAndy Whitcroft 2559cb710ecaSJoe Perches# check for static const char * arrays. 2560cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2561000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2562000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 2563cb710ecaSJoe Perches $herecurr); 2564cb710ecaSJoe Perches } 2565cb710ecaSJoe Perches 2566cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 2567cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2568000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2569000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 2570cb710ecaSJoe Perches $herecurr); 2571cb710ecaSJoe Perches } 2572cb710ecaSJoe Perches 257393ed0e2dSJoe Perches# check for declarations of struct pci_device_id 257493ed0e2dSJoe Perches if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) { 2575000d1cc1SJoe Perches WARN("DEFINE_PCI_DEVICE_TABLE", 2576000d1cc1SJoe Perches "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr); 257793ed0e2dSJoe Perches } 257893ed0e2dSJoe Perches 2579653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 2580653d4876SAndy Whitcroft# make sense. 2581653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 25828054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 2583c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 25848ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 2585653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 2586000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 2587000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 25880a920b5bSAndy Whitcroft } 25890a920b5bSAndy Whitcroft 25900a920b5bSAndy Whitcroft# * goes on variable not on type 259165863862SAndy Whitcroft # (char*[ const]) 2592bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 2593bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 25943705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 2595d8aaf121SAndy Whitcroft 259665863862SAndy Whitcroft # Should start with a space. 259765863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 259865863862SAndy Whitcroft # Should not end with a space. 259965863862SAndy Whitcroft $to =~ s/\s+$//; 260065863862SAndy Whitcroft # '*'s should not have spaces between. 2601f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 260265863862SAndy Whitcroft } 2603d8aaf121SAndy Whitcroft 26043705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 260565863862SAndy Whitcroft if ($from ne $to) { 26063705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 26073705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 26083705ce5bSJoe Perches $fix) { 26093705ce5bSJoe Perches my $sub_from = $ident; 26103705ce5bSJoe Perches my $sub_to = $ident; 26113705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 26123705ce5bSJoe Perches $fixed[$linenr - 1] =~ 26133705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 26143705ce5bSJoe Perches } 261565863862SAndy Whitcroft } 2616bfcb2cc7SAndy Whitcroft } 2617bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 2618bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 26193705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 2620d8aaf121SAndy Whitcroft 262165863862SAndy Whitcroft # Should start with a space. 262265863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 262365863862SAndy Whitcroft # Should not end with a space. 262465863862SAndy Whitcroft $to =~ s/\s+$//; 262565863862SAndy Whitcroft # '*'s should not have spaces between. 2626f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 262765863862SAndy Whitcroft } 262865863862SAndy Whitcroft # Modifiers should have spaces. 262965863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 263065863862SAndy Whitcroft 26313705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 2632667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 26333705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 26343705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 26353705ce5bSJoe Perches $fix) { 26363705ce5bSJoe Perches 26373705ce5bSJoe Perches my $sub_from = $match; 26383705ce5bSJoe Perches my $sub_to = $match; 26393705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 26403705ce5bSJoe Perches $fixed[$linenr - 1] =~ 26413705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 26423705ce5bSJoe Perches } 264365863862SAndy Whitcroft } 26440a920b5bSAndy Whitcroft } 26450a920b5bSAndy Whitcroft 26460a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 26470a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 26480a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 26490a920b5bSAndy Whitcroft# print "$herecurr"; 26500a920b5bSAndy Whitcroft# $clean = 0; 26510a920b5bSAndy Whitcroft# } 26520a920b5bSAndy Whitcroft 26538905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 2654000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 2655000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 26568905a67cSAndy Whitcroft } 26578905a67cSAndy Whitcroft 265817441227SJoe Perches# check for uses of printk_ratelimit 265917441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 2660000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 2661000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 266217441227SJoe Perches } 266317441227SJoe Perches 266400df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 266500df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 266600df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 266725985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 266800df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 2669f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 267000df344fSAndy Whitcroft my $ok = 0; 267100df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 267200df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 267325985edcSLucas De Marchi # we have a preceding printk if it ends 267400df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 267500df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 267600df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 267700df344fSAndy Whitcroft $ok = 1; 267800df344fSAndy Whitcroft } 267900df344fSAndy Whitcroft last; 268000df344fSAndy Whitcroft } 268100df344fSAndy Whitcroft } 268200df344fSAndy Whitcroft if ($ok == 0) { 2683000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 2684000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 26850a920b5bSAndy Whitcroft } 268600df344fSAndy Whitcroft } 26870a920b5bSAndy Whitcroft 2688243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 2689243f3803SJoe Perches my $orig = $1; 2690243f3803SJoe Perches my $level = lc($orig); 2691243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 26928f26b837SJoe Perches my $level2 = $level; 26938f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 2694243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 26958f26b837SJoe Perches "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 2696243f3803SJoe Perches } 2697243f3803SJoe Perches 2698243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 2699d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 2700d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 2701d5e616fcSJoe Perches $fix) { 2702d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 2703d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 2704d5e616fcSJoe Perches } 2705243f3803SJoe Perches } 2706243f3803SJoe Perches 2707dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 2708dc139313SJoe Perches my $orig = $1; 2709dc139313SJoe Perches my $level = lc($orig); 2710dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 2711dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 2712dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 2713dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 2714dc139313SJoe Perches } 2715dc139313SJoe Perches 2716653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 2717653d4876SAndy Whitcroft# or if closed on same line 2718c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 2719c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 2720000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2721000d1cc1SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr); 27220a920b5bSAndy Whitcroft } 2723653d4876SAndy Whitcroft 27248905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 27258905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 27268905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2727000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2728000d1cc1SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev); 27298905a67cSAndy Whitcroft } 27308905a67cSAndy Whitcroft 27310c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 27323705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 27333705ce5bSJoe Perches if (WARN("SPACING", 27343705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 27353705ce5bSJoe Perches $fix) { 27363705ce5bSJoe Perches $fixed[$linenr - 1] =~ 27373705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 27383705ce5bSJoe Perches } 27390c73b4ebSAndy Whitcroft } 27400c73b4ebSAndy Whitcroft 27418d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 27428d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 2743fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 2744fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 27458d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 27468d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 27478d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 2748fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 2749daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 27503705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 27513705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 27523705ce5bSJoe Perches $fix) { 27533705ce5bSJoe Perches $fixed[$linenr - 1] =~ 27543705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 27553705ce5bSJoe Perches } 27568d31cfceSAndy Whitcroft } 27578d31cfceSAndy Whitcroft } 27588d31cfceSAndy Whitcroft 2759f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 27606c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 2761c2fdda0dSAndy Whitcroft my $name = $1; 2762773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 2763773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 2764c2fdda0dSAndy Whitcroft 2765c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 2766773647a0SAndy Whitcroft if ($name =~ /^(?: 2767773647a0SAndy Whitcroft if|for|while|switch|return|case| 2768773647a0SAndy Whitcroft volatile|__volatile__| 2769773647a0SAndy Whitcroft __attribute__|format|__extension__| 2770773647a0SAndy Whitcroft asm|__asm__)$/x) 2771773647a0SAndy Whitcroft { 2772c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 2773c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 2774c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 2775c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 2776773647a0SAndy Whitcroft 2777773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 2778c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 2779c2fdda0dSAndy Whitcroft 2780c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 2781c2fdda0dSAndy Whitcroft # likely a typedef for a function. 2782773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 2783c2fdda0dSAndy Whitcroft 2784c2fdda0dSAndy Whitcroft } else { 27853705ce5bSJoe Perches if (WARN("SPACING", 27863705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 27873705ce5bSJoe Perches $fix) { 27883705ce5bSJoe Perches $fixed[$linenr - 1] =~ 27893705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 27903705ce5bSJoe Perches } 2791f0a594c1SAndy Whitcroft } 27926c72ffaaSAndy Whitcroft } 27939a4cad4eSEric Nelson 2794653d4876SAndy Whitcroft# Check operator spacing. 27950a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 27963705ce5bSJoe Perches my $fixed_line = ""; 27973705ce5bSJoe Perches my $line_fixed = 0; 27983705ce5bSJoe Perches 27999c0ca6f9SAndy Whitcroft my $ops = qr{ 28009c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 28019c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 28029c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 28031f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 28041f65f947SAndy Whitcroft \?|: 28059c0ca6f9SAndy Whitcroft }x; 2806cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 28073705ce5bSJoe Perches 28083705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 28093705ce5bSJoe Perches## foreach my $el (@elements) { 28103705ce5bSJoe Perches## print("el: <$el>\n"); 28113705ce5bSJoe Perches## } 28123705ce5bSJoe Perches 28133705ce5bSJoe Perches my @fix_elements = (); 281400df344fSAndy Whitcroft my $off = 0; 28156c72ffaaSAndy Whitcroft 28163705ce5bSJoe Perches foreach my $el (@elements) { 28173705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 28183705ce5bSJoe Perches $off += length($el); 28193705ce5bSJoe Perches } 28203705ce5bSJoe Perches 28213705ce5bSJoe Perches $off = 0; 28223705ce5bSJoe Perches 28236c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 28246c72ffaaSAndy Whitcroft 28250a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 28263705ce5bSJoe Perches 28273705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 28283705ce5bSJoe Perches 28293705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 28303705ce5bSJoe Perches 28314a0df2efSAndy Whitcroft $off += length($elements[$n]); 28324a0df2efSAndy Whitcroft 283325985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 2834773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 2835773647a0SAndy Whitcroft my $cc = ''; 2836773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 2837773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 2838773647a0SAndy Whitcroft } 2839773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 2840773647a0SAndy Whitcroft 28414a0df2efSAndy Whitcroft my $a = ''; 28424a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 28434a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 2844cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 28454a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 28464a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 2847773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 28484a0df2efSAndy Whitcroft 28490a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 28504a0df2efSAndy Whitcroft 28514a0df2efSAndy Whitcroft my $c = ''; 28520a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 28534a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 28544a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 2855cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 28564a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 28574a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 28588b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 28594a0df2efSAndy Whitcroft } else { 28604a0df2efSAndy Whitcroft $c = 'E'; 28610a920b5bSAndy Whitcroft } 28620a920b5bSAndy Whitcroft 28634a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 28644a0df2efSAndy Whitcroft 28654a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 28664a0df2efSAndy Whitcroft 28676c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 2868de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 28690a920b5bSAndy Whitcroft 287074048ed8SAndy Whitcroft # Pull out the value of this operator. 28716c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 28720a920b5bSAndy Whitcroft 28731f65f947SAndy Whitcroft # Get the full operator variant. 28741f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 28751f65f947SAndy Whitcroft 287613214adfSAndy Whitcroft # Ignore operators passed as parameters. 287713214adfSAndy Whitcroft if ($op_type ne 'V' && 287813214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 287913214adfSAndy Whitcroft 2880cf655043SAndy Whitcroft# # Ignore comments 2881cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 288213214adfSAndy Whitcroft 2883d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 288413214adfSAndy Whitcroft } elsif ($op eq ';') { 2885cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 2886cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 28873705ce5bSJoe Perches if (ERROR("SPACING", 28883705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 28893705ce5bSJoe Perches $good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 28903705ce5bSJoe Perches $line_fixed = 1; 28913705ce5bSJoe Perches } 2892d8aaf121SAndy Whitcroft } 2893d8aaf121SAndy Whitcroft 2894d8aaf121SAndy Whitcroft # // is a comment 2895d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 28960a920b5bSAndy Whitcroft 28971f65f947SAndy Whitcroft # No spaces for: 28981f65f947SAndy Whitcroft # -> 28991f65f947SAndy Whitcroft # : when part of a bitfield 29001f65f947SAndy Whitcroft } elsif ($op eq '->' || $opv eq ':B') { 29014a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 29023705ce5bSJoe Perches if (ERROR("SPACING", 29033705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 29043705ce5bSJoe Perches $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 29053705ce5bSJoe Perches $line_fixed = 1; 29063705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 29073705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 29083705ce5bSJoe Perches } 29093705ce5bSJoe Perches } 29100a920b5bSAndy Whitcroft } 29110a920b5bSAndy Whitcroft 29120a920b5bSAndy Whitcroft # , must have a space on the right. 29130a920b5bSAndy Whitcroft } elsif ($op eq ',') { 2914cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 29153705ce5bSJoe Perches if (ERROR("SPACING", 29163705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 29173705ce5bSJoe Perches $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]) . " "; 29183705ce5bSJoe Perches $line_fixed = 1; 29193705ce5bSJoe Perches } 29200a920b5bSAndy Whitcroft } 29210a920b5bSAndy Whitcroft 29229c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 292374048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 29249c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 29259c0ca6f9SAndy Whitcroft 29269c0ca6f9SAndy Whitcroft # unary operators should have a space before and 29279c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 29289c0ca6f9SAndy Whitcroft # unary operator, or a cast 29299c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 293074048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 29310d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 2932cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 29333705ce5bSJoe Perches if (ERROR("SPACING", 29343705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 29353705ce5bSJoe Perches $good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 29363705ce5bSJoe Perches $line_fixed = 1; 29373705ce5bSJoe Perches } 29380a920b5bSAndy Whitcroft } 2939a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 2940171ae1a4SAndy Whitcroft # A unary '*' may be const 2941171ae1a4SAndy Whitcroft 2942171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 29433705ce5bSJoe Perches if (ERROR("SPACING", 29443705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 29453705ce5bSJoe Perches $fixed_line =~ s/\s+$//; 29463705ce5bSJoe Perches $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 29473705ce5bSJoe Perches $line_fixed = 1; 29483705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 29493705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 29503705ce5bSJoe Perches } 29513705ce5bSJoe Perches } 29520a920b5bSAndy Whitcroft } 29530a920b5bSAndy Whitcroft 29540a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 29550a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 2956773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 29573705ce5bSJoe Perches if (ERROR("SPACING", 29583705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 29593705ce5bSJoe Perches $fixed_line =~ s/\s+$//; 29603705ce5bSJoe Perches $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]) . " "; 29613705ce5bSJoe Perches $line_fixed = 1; 29623705ce5bSJoe Perches } 29630a920b5bSAndy Whitcroft } 2964773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 2965773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 29663705ce5bSJoe Perches if (ERROR("SPACING", 29673705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 29683705ce5bSJoe Perches $fixed_line =~ s/\s+$//; 29693705ce5bSJoe Perches $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 29703705ce5bSJoe Perches $line_fixed = 1; 29713705ce5bSJoe Perches } 2972653d4876SAndy Whitcroft } 2973773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 29743705ce5bSJoe Perches if (ERROR("SPACING", 29753705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 29763705ce5bSJoe Perches $fixed_line =~ s/\s+$//; 29773705ce5bSJoe Perches $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 29783705ce5bSJoe Perches $line_fixed = 1; 29793705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 29803705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 2981773647a0SAndy Whitcroft } 29823705ce5bSJoe Perches } 29833705ce5bSJoe Perches } 29840a920b5bSAndy Whitcroft 29850a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 29869c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 29879c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 29889c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 2989c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 2990c2fdda0dSAndy Whitcroft $op eq '%') 29910a920b5bSAndy Whitcroft { 2992773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 29933705ce5bSJoe Perches if (ERROR("SPACING", 29943705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 29953705ce5bSJoe Perches $fixed_line =~ s/\s+$//; 29963705ce5bSJoe Perches $good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 29973705ce5bSJoe Perches $line_fixed = 1; 29983705ce5bSJoe Perches } 29990a920b5bSAndy Whitcroft } 30000a920b5bSAndy Whitcroft 30011f65f947SAndy Whitcroft # A colon needs no spaces before when it is 30021f65f947SAndy Whitcroft # terminating a case value or a label. 30031f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 30041f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 30053705ce5bSJoe Perches if (ERROR("SPACING", 30063705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 30073705ce5bSJoe Perches $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 30083705ce5bSJoe Perches $line_fixed = 1; 30093705ce5bSJoe Perches } 30101f65f947SAndy Whitcroft } 30111f65f947SAndy Whitcroft 30120a920b5bSAndy Whitcroft # All the others need spaces both sides. 3013cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 30141f65f947SAndy Whitcroft my $ok = 0; 30151f65f947SAndy Whitcroft 301622f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 30171f65f947SAndy Whitcroft if (($op eq '<' && 30181f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 30191f65f947SAndy Whitcroft ($op eq '>' && 30201f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 30211f65f947SAndy Whitcroft { 30221f65f947SAndy Whitcroft $ok = 1; 30231f65f947SAndy Whitcroft } 30241f65f947SAndy Whitcroft 30251f65f947SAndy Whitcroft # Ignore ?: 30261f65f947SAndy Whitcroft if (($opv eq ':O' && $ca =~ /\?$/) || 30271f65f947SAndy Whitcroft ($op eq '?' && $cc =~ /^:/)) { 30281f65f947SAndy Whitcroft $ok = 1; 30291f65f947SAndy Whitcroft } 30301f65f947SAndy Whitcroft 30311f65f947SAndy Whitcroft if ($ok == 0) { 30323705ce5bSJoe Perches if (ERROR("SPACING", 30333705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 30343705ce5bSJoe Perches $good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 30353705ce5bSJoe Perches $good = $fix_elements[$n] . " " . trim($fix_elements[$n + 1]) . " "; 30363705ce5bSJoe Perches $line_fixed = 1; 30373705ce5bSJoe Perches } 30380a920b5bSAndy Whitcroft } 303922f2a2efSAndy Whitcroft } 30404a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 30413705ce5bSJoe Perches 30423705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 30433705ce5bSJoe Perches 30443705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 30450a920b5bSAndy Whitcroft } 30463705ce5bSJoe Perches 30473705ce5bSJoe Perches if (($#elements % 2) == 0) { 30483705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 30493705ce5bSJoe Perches } 30503705ce5bSJoe Perches 30513705ce5bSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) { 30523705ce5bSJoe Perches $fixed[$linenr - 1] = $fixed_line; 30533705ce5bSJoe Perches } 30543705ce5bSJoe Perches 30553705ce5bSJoe Perches 30560a920b5bSAndy Whitcroft } 30570a920b5bSAndy Whitcroft 3058786b6326SJoe Perches# check for whitespace before a non-naked semicolon 3059786b6326SJoe Perches if ($line =~ /^\+.*\S\s+;/) { 3060786b6326SJoe Perches if (WARN("SPACING", 3061786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 3062786b6326SJoe Perches $fix) { 3063786b6326SJoe Perches 1 while $fixed[$linenr - 1] =~ 3064786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 3065786b6326SJoe Perches } 3066786b6326SJoe Perches } 3067786b6326SJoe Perches 3068f0a594c1SAndy Whitcroft# check for multiple assignments 3069f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 3070000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 3071000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 3072f0a594c1SAndy Whitcroft } 3073f0a594c1SAndy Whitcroft 307422f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 307522f2a2efSAndy Whitcroft## # continuation. 307622f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 307722f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 307822f2a2efSAndy Whitcroft## 307922f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 308022f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 308122f2a2efSAndy Whitcroft## my $ln = $line; 308222f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 308322f2a2efSAndy Whitcroft## } 308422f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 3085000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 3086000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 308722f2a2efSAndy Whitcroft## } 308822f2a2efSAndy Whitcroft## } 3089f0a594c1SAndy Whitcroft 30900a920b5bSAndy Whitcroft#need space before brace following if, while, etc 309122f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 309222f2a2efSAndy Whitcroft $line =~ /do{/) { 30933705ce5bSJoe Perches if (ERROR("SPACING", 30943705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 30953705ce5bSJoe Perches $fix) { 3096d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/; 30973705ce5bSJoe Perches } 3098de7d4f0eSAndy Whitcroft } 3099de7d4f0eSAndy Whitcroft 3100c4a62ef9SJoe Perches## # check for blank lines before declarations 3101c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 3102c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 3103c4a62ef9SJoe Perches## WARN("SPACING", 3104c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 3105c4a62ef9SJoe Perches## } 3106c4a62ef9SJoe Perches## 3107c4a62ef9SJoe Perches 3108de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 3109de7d4f0eSAndy Whitcroft# on the line 3110de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 3111d5e616fcSJoe Perches if (ERROR("SPACING", 3112d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 3113d5e616fcSJoe Perches $fix) { 3114d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 3115d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 3116d5e616fcSJoe Perches } 31170a920b5bSAndy Whitcroft } 31180a920b5bSAndy Whitcroft 311922f2a2efSAndy Whitcroft# check spacing on square brackets 312022f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 31213705ce5bSJoe Perches if (ERROR("SPACING", 31223705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 31233705ce5bSJoe Perches $fix) { 31243705ce5bSJoe Perches $fixed[$linenr - 1] =~ 31253705ce5bSJoe Perches s/\[\s+/\[/; 31263705ce5bSJoe Perches } 312722f2a2efSAndy Whitcroft } 312822f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 31293705ce5bSJoe Perches if (ERROR("SPACING", 31303705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 31313705ce5bSJoe Perches $fix) { 31323705ce5bSJoe Perches $fixed[$linenr - 1] =~ 31333705ce5bSJoe Perches s/\s+\]/\]/; 31343705ce5bSJoe Perches } 313522f2a2efSAndy Whitcroft } 313622f2a2efSAndy Whitcroft 3137c45dcabdSAndy Whitcroft# check spacing on parentheses 31389c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 31399c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 31403705ce5bSJoe Perches if (ERROR("SPACING", 31413705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 31423705ce5bSJoe Perches $fix) { 31433705ce5bSJoe Perches $fixed[$linenr - 1] =~ 31443705ce5bSJoe Perches s/\(\s+/\(/; 31453705ce5bSJoe Perches } 314622f2a2efSAndy Whitcroft } 314713214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 3148c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 3149c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 31503705ce5bSJoe Perches if (ERROR("SPACING", 31513705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 31523705ce5bSJoe Perches $fix) { 31533705ce5bSJoe Perches $fixed[$linenr - 1] =~ 31543705ce5bSJoe Perches s/\s+\)/\)/; 31553705ce5bSJoe Perches } 315622f2a2efSAndy Whitcroft } 315722f2a2efSAndy Whitcroft 31580a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 31594a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 31600a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 31613705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 31623705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 31633705ce5bSJoe Perches $fix) { 31643705ce5bSJoe Perches $fixed[$linenr - 1] =~ 31653705ce5bSJoe Perches s/^(.)\s+/$1/; 31663705ce5bSJoe Perches } 31670a920b5bSAndy Whitcroft } 31680a920b5bSAndy Whitcroft 3169c45dcabdSAndy Whitcroft# Return is not a function. 3170c45dcabdSAndy Whitcroft if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { 3171c45dcabdSAndy Whitcroft my $spacing = $1; 3172c45dcabdSAndy Whitcroft my $value = $2; 3173c45dcabdSAndy Whitcroft 317486f9d059SAndy Whitcroft # Flatten any parentheses 3175fb2d2c1bSAndy Whitcroft $value =~ s/\(/ \(/g; 3176fb2d2c1bSAndy Whitcroft $value =~ s/\)/\) /g; 3177e01886adSAndy Whitcroft while ($value =~ s/\[[^\[\]]*\]/1/ || 317863f17f89SAndy Whitcroft $value !~ /(?:$Ident|-?$Constant)\s* 317963f17f89SAndy Whitcroft $Compare\s* 318063f17f89SAndy Whitcroft (?:$Ident|-?$Constant)/x && 318163f17f89SAndy Whitcroft $value =~ s/\([^\(\)]*\)/1/) { 3182c45dcabdSAndy Whitcroft } 3183fb2d2c1bSAndy Whitcroft#print "value<$value>\n"; 3184fb2d2c1bSAndy Whitcroft if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) { 3185000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 3186000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 3187c45dcabdSAndy Whitcroft 3188c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 3189000d1cc1SJoe Perches ERROR("SPACING", 3190000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 3191c45dcabdSAndy Whitcroft } 3192c45dcabdSAndy Whitcroft } 319353a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 319453a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 319553a3c448SAndy Whitcroft my $name = $1; 319653a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 3197000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 3198000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 319953a3c448SAndy Whitcroft } 320053a3c448SAndy Whitcroft } 3201c45dcabdSAndy Whitcroft 32020a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 32034a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 32043705ce5bSJoe Perches if (ERROR("SPACING", 32053705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 32063705ce5bSJoe Perches $fix) { 32073705ce5bSJoe Perches $fixed[$linenr - 1] =~ 32083705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 32093705ce5bSJoe Perches } 32100a920b5bSAndy Whitcroft } 32110a920b5bSAndy Whitcroft 3212f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 3213f5fe35ddSAndy Whitcroft# statements after the conditional. 3214170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 32153e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 32163e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 32173e469cdcSAndy Whitcroft if (!defined $stat); 3218170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 3219170d3a22SAndy Whitcroft $remain_next, $off_next); 3220170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 3221170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 3222170d3a22SAndy Whitcroft 3223170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 3224170d3a22SAndy Whitcroft # If the statement carries leading newlines, 3225170d3a22SAndy Whitcroft # then count those as offsets. 3226170d3a22SAndy Whitcroft my ($whitespace) = 3227170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 3228170d3a22SAndy Whitcroft my $offset = 3229170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 3230170d3a22SAndy Whitcroft 3231170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 3232170d3a22SAndy Whitcroft $offset} = 1; 3233170d3a22SAndy Whitcroft } 3234170d3a22SAndy Whitcroft } 3235170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 3236170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 3237171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 32388905a67cSAndy Whitcroft 3239b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 3240000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 3241000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 32428905a67cSAndy Whitcroft } 32438905a67cSAndy Whitcroft 32448905a67cSAndy Whitcroft # Find out what is on the end of the line after the 32458905a67cSAndy Whitcroft # conditional. 3246773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 32478905a67cSAndy Whitcroft $s =~ s/\n.*//g; 324813214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 324953210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 325053210168SAndy Whitcroft $c !~ /}\s*while\s*/) 3251773647a0SAndy Whitcroft { 3252bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 3253bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 3254bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 325542bdf74cSHidetoshi Seto my $stat_real = ''; 3256bb44ad39SAndy Whitcroft 325742bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 325842bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 3259bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 3260bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 3261bb44ad39SAndy Whitcroft } 3262bb44ad39SAndy Whitcroft 3263000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3264000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 32658905a67cSAndy Whitcroft } 32668905a67cSAndy Whitcroft } 32678905a67cSAndy Whitcroft 326813214adfSAndy Whitcroft# Check for bitwise tests written as boolean 326913214adfSAndy Whitcroft if ($line =~ / 327013214adfSAndy Whitcroft (?: 327113214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 327213214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 327313214adfSAndy Whitcroft (?:\&\&|\|\|) 327413214adfSAndy Whitcroft | 327513214adfSAndy Whitcroft (?:\&\&|\|\|) 327613214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 327713214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 327813214adfSAndy Whitcroft )/x) 327913214adfSAndy Whitcroft { 3280000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 3281000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 328213214adfSAndy Whitcroft } 328313214adfSAndy Whitcroft 32848905a67cSAndy Whitcroft# if and else should not have general statements after it 328513214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 328613214adfSAndy Whitcroft my $s = $1; 328713214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 328813214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 3289000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3290000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 32910a920b5bSAndy Whitcroft } 329213214adfSAndy Whitcroft } 329339667782SAndy Whitcroft# if should not continue a brace 329439667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 3295000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3296000d1cc1SJoe Perches "trailing statements should be on next line\n" . 329739667782SAndy Whitcroft $herecurr); 329839667782SAndy Whitcroft } 3299a1080bf8SAndy Whitcroft# case and default should not have general statements after them 3300a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 3301a1080bf8SAndy Whitcroft $line !~ /\G(?: 33023fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 3303a1080bf8SAndy Whitcroft \s*return\s+ 3304a1080bf8SAndy Whitcroft )/xg) 3305a1080bf8SAndy Whitcroft { 3306000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3307000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 3308a1080bf8SAndy Whitcroft } 33090a920b5bSAndy Whitcroft 33100a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 33110a920b5bSAndy Whitcroft # indent level to be relevant to each other. 33120a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 33130a920b5bSAndy Whitcroft $previndent == $indent) { 3314000d1cc1SJoe Perches ERROR("ELSE_AFTER_BRACE", 3315000d1cc1SJoe Perches "else should follow close brace '}'\n" . $hereprev); 33160a920b5bSAndy Whitcroft } 33170a920b5bSAndy Whitcroft 3318c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 3319c2fdda0dSAndy Whitcroft $previndent == $indent) { 3320c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 3321c2fdda0dSAndy Whitcroft 3322c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 3323c2fdda0dSAndy Whitcroft # conditional. 3324773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 3325c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 3326c2fdda0dSAndy Whitcroft 3327c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 3328000d1cc1SJoe Perches ERROR("WHILE_AFTER_BRACE", 3329000d1cc1SJoe Perches "while should follow close brace '}'\n" . $hereprev); 3330c2fdda0dSAndy Whitcroft } 3331c2fdda0dSAndy Whitcroft } 3332c2fdda0dSAndy Whitcroft 333395e2c602SJoe Perches#Specific variable tests 3334323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 3335323c1260SJoe Perches my $var = $1; 333695e2c602SJoe Perches 333795e2c602SJoe Perches#gcc binary extension 333895e2c602SJoe Perches if ($var =~ /^$Binary$/) { 3339d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 3340d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 3341d5e616fcSJoe Perches $fix) { 3342d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 3343d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 3344d5e616fcSJoe Perches s/\b$var\b/$hexval/; 3345d5e616fcSJoe Perches } 334695e2c602SJoe Perches } 334795e2c602SJoe Perches 334895e2c602SJoe Perches#CamelCase 3349807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 3350be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 335122735ce8SJoe Perches#Ignore Page<foo> variants 3352807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 335322735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 33543445686aSJoe Perches $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) { 33557e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 33567e781f67SJoe Perches my $word = $1; 33577e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 33583445686aSJoe Perches seed_camelcase_includes() if ($check); 33597e781f67SJoe Perches if (!defined $camelcase{$word}) { 33607e781f67SJoe Perches $camelcase{$word} = 1; 3361be79794bSJoe Perches CHK("CAMELCASE", 33627e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 33637e781f67SJoe Perches } 3364323c1260SJoe Perches } 3365323c1260SJoe Perches } 33663445686aSJoe Perches } 33670a920b5bSAndy Whitcroft 33680a920b5bSAndy Whitcroft#no spaces allowed after \ in define 3369d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 3370d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 3371d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 3372d5e616fcSJoe Perches $fix) { 3373d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\s+$//; 3374d5e616fcSJoe Perches } 33750a920b5bSAndy Whitcroft } 33760a920b5bSAndy Whitcroft 3377653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 3378c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 3379e09dec48SAndy Whitcroft my $file = "$1.h"; 3380e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 3381e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 3382e09dec48SAndy Whitcroft $realfile ne $checkfile && 33837840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 3384c45dcabdSAndy Whitcroft { 3385e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 3386000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 3387000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3388e09dec48SAndy Whitcroft } else { 3389000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 3390000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3391e09dec48SAndy Whitcroft } 33920a920b5bSAndy Whitcroft } 33930a920b5bSAndy Whitcroft } 33940a920b5bSAndy Whitcroft 3395653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 3396653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 3397cf655043SAndy Whitcroft# in a known good container 3398b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 3399b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 3400d8aaf121SAndy Whitcroft my $ln = $linenr; 3401d8aaf121SAndy Whitcroft my $cnt = $realcnt; 3402c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 3403c45dcabdSAndy Whitcroft my $ctx = ''; 3404c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 3405f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3406f74bd194SAndy Whitcroft $ctx = $dstat; 3407c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 3408a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 3409c45dcabdSAndy Whitcroft 3410f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 3411292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 3412c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 3413c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 3414c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 3415c45dcabdSAndy Whitcroft 3416c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 3417bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 3418bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 3419c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 3420bf30d6edSAndy Whitcroft { 3421c45dcabdSAndy Whitcroft } 3422c45dcabdSAndy Whitcroft 3423e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 3424e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 3425e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 3426e45bab8eSAndy Whitcroft { 3427e45bab8eSAndy Whitcroft } 3428e45bab8eSAndy Whitcroft 3429c45dcabdSAndy Whitcroft my $exceptions = qr{ 3430c45dcabdSAndy Whitcroft $Declare| 3431c45dcabdSAndy Whitcroft module_param_named| 3432a0a0a7a9SKees Cook MODULE_PARM_DESC| 3433c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 3434c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 3435383099fdSAndy Whitcroft __typeof__\(| 343622fd2d3eSStefani Seibold union| 343722fd2d3eSStefani Seibold struct| 3438ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 3439ea71a0a0SAndy Whitcroft ^\"|\"$ 3440c45dcabdSAndy Whitcroft }x; 34415eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 3442f74bd194SAndy Whitcroft if ($dstat ne '' && 3443f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 3444f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 34453cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 3446b9df76acSAndy Whitcroft $dstat !~ /^'X'$/ && # character constants 3447f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 3448f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 3449e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 345072f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 3451f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 3452f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 3453f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 3454f74bd194SAndy Whitcroft $dstat !~ /^\({/) # ({... 3455c45dcabdSAndy Whitcroft { 3456f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 3457f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 3458f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 3459f74bd194SAndy Whitcroft 3460f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 3461f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 3462c45dcabdSAndy Whitcroft } 3463c45dcabdSAndy Whitcroft 3464f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 3465f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 3466f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 3467f74bd194SAndy Whitcroft } else { 3468000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 3469f74bd194SAndy Whitcroft "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); 3470d8aaf121SAndy Whitcroft } 34710a920b5bSAndy Whitcroft } 34725023d347SJoe Perches 3473481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 34745023d347SJoe Perches 34755023d347SJoe Perches } else { 34765023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 3477481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 3478481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 34795023d347SJoe Perches $line =~ /^\+.*\\$/) { 34805023d347SJoe Perches WARN("LINE_CONTINUATIONS", 34815023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 34825023d347SJoe Perches } 3483653d4876SAndy Whitcroft } 34840a920b5bSAndy Whitcroft 3485b13edf7fSJoe Perches# do {} while (0) macro tests: 3486b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 3487b13edf7fSJoe Perches# macro should not end with a semicolon 3488b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 3489b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 3490b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 3491b13edf7fSJoe Perches my $ln = $linenr; 3492b13edf7fSJoe Perches my $cnt = $realcnt; 3493b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 3494b13edf7fSJoe Perches my $ctx = ''; 3495b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 3496b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 3497b13edf7fSJoe Perches $ctx = $dstat; 3498b13edf7fSJoe Perches 3499b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 3500b13edf7fSJoe Perches 3501b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 3502b13edf7fSJoe Perches my $stmts = $2; 3503b13edf7fSJoe Perches my $semis = $3; 3504b13edf7fSJoe Perches 3505b13edf7fSJoe Perches $ctx =~ s/\n*$//; 3506b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 3507b13edf7fSJoe Perches my $herectx = $here . "\n"; 3508b13edf7fSJoe Perches 3509b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3510b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3511b13edf7fSJoe Perches } 3512b13edf7fSJoe Perches 3513ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 3514ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 3515b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 3516b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 3517b13edf7fSJoe Perches } 3518b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 3519b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 3520b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 3521b13edf7fSJoe Perches } 3522b13edf7fSJoe Perches } 3523b13edf7fSJoe Perches } 3524b13edf7fSJoe Perches 3525080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 3526080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 3527080ba929SMike Frysinger# . 3528080ba929SMike Frysinger# ALIGN(...) 3529080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 3530080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 3531000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 3532000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 3533080ba929SMike Frysinger } 3534080ba929SMike Frysinger 3535f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 353613214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 353713214adfSAndy Whitcroft my ($level, $endln, @chunks) = 3538cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 353913214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 3540cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 3541cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 3542aad4f614SJoe Perches my @allowed = (); 3543aad4f614SJoe Perches my $allow = 0; 354413214adfSAndy Whitcroft my $seen = 0; 3545773647a0SAndy Whitcroft my $herectx = $here . "\n"; 3546cf655043SAndy Whitcroft my $ln = $linenr - 1; 354713214adfSAndy Whitcroft for my $chunk (@chunks) { 354813214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 354913214adfSAndy Whitcroft 3550773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 3551773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 3552773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 3553773647a0SAndy Whitcroft 3554aad4f614SJoe Perches $allowed[$allow] = 0; 3555773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 3556773647a0SAndy Whitcroft 3557773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 3558773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 3559773647a0SAndy Whitcroft 3560773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 3561cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 3562cf655043SAndy Whitcroft 3563773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 356413214adfSAndy Whitcroft 356513214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 356613214adfSAndy Whitcroft 3567aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 3568cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3569cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3570aad4f614SJoe Perches $allowed[$allow] = 1; 357113214adfSAndy Whitcroft } 357213214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3573cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3574aad4f614SJoe Perches $allowed[$allow] = 1; 357513214adfSAndy Whitcroft } 3576cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3577cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3578aad4f614SJoe Perches $allowed[$allow] = 1; 357913214adfSAndy Whitcroft } 3580aad4f614SJoe Perches $allow++; 358113214adfSAndy Whitcroft } 3582aad4f614SJoe Perches if ($seen) { 3583aad4f614SJoe Perches my $sum_allowed = 0; 3584aad4f614SJoe Perches foreach (@allowed) { 3585aad4f614SJoe Perches $sum_allowed += $_; 3586aad4f614SJoe Perches } 3587aad4f614SJoe Perches if ($sum_allowed == 0) { 3588000d1cc1SJoe Perches WARN("BRACES", 3589000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 3590aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 3591aad4f614SJoe Perches $seen != $allow) { 3592aad4f614SJoe Perches CHK("BRACES", 3593aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 3594aad4f614SJoe Perches } 359513214adfSAndy Whitcroft } 359613214adfSAndy Whitcroft } 359713214adfSAndy Whitcroft } 3598773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 359913214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 3600cf655043SAndy Whitcroft my $allowed = 0; 3601f0a594c1SAndy Whitcroft 3602cf655043SAndy Whitcroft # Check the pre-context. 3603cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 3604cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 3605cf655043SAndy Whitcroft $allowed = 1; 3606f0a594c1SAndy Whitcroft } 3607773647a0SAndy Whitcroft 3608773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 3609773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 3610773647a0SAndy Whitcroft 3611cf655043SAndy Whitcroft # Check the condition. 3612cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 3613773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 3614cf655043SAndy Whitcroft if (defined $cond) { 3615773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3616cf655043SAndy Whitcroft } 3617cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3618cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3619cf655043SAndy Whitcroft $allowed = 1; 3620cf655043SAndy Whitcroft } 3621cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3622cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3623cf655043SAndy Whitcroft $allowed = 1; 3624cf655043SAndy Whitcroft } 3625cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3626cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3627cf655043SAndy Whitcroft $allowed = 1; 3628cf655043SAndy Whitcroft } 3629cf655043SAndy Whitcroft # Check the post-context. 3630cf655043SAndy Whitcroft if (defined $chunks[1]) { 3631cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 3632cf655043SAndy Whitcroft if (defined $cond) { 3633773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3634cf655043SAndy Whitcroft } 3635cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 3636cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 3637cf655043SAndy Whitcroft $allowed = 1; 3638cf655043SAndy Whitcroft } 3639cf655043SAndy Whitcroft } 3640cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 364169932487SJustin P. Mattock my $herectx = $here . "\n"; 3642f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 3643cf655043SAndy Whitcroft 3644f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 364569932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 3646cf655043SAndy Whitcroft } 3647cf655043SAndy Whitcroft 3648000d1cc1SJoe Perches WARN("BRACES", 3649000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 3650f0a594c1SAndy Whitcroft } 3651f0a594c1SAndy Whitcroft } 3652f0a594c1SAndy Whitcroft 36530979ae66SJoe Perches# check for unnecessary blank lines around braces 365477b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 36550979ae66SJoe Perches CHK("BRACES", 36560979ae66SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev); 36570979ae66SJoe Perches } 365877b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 36590979ae66SJoe Perches CHK("BRACES", 36600979ae66SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev); 36610979ae66SJoe Perches } 36620979ae66SJoe Perches 36634a0df2efSAndy Whitcroft# no volatiles please 36646c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 36656c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 3666000d1cc1SJoe Perches WARN("VOLATILE", 3667000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 36684a0df2efSAndy Whitcroft } 36694a0df2efSAndy Whitcroft 367000df344fSAndy Whitcroft# warn about #if 0 3671c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 3672000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 3673000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 3674de7d4f0eSAndy Whitcroft $herecurr); 36754a0df2efSAndy Whitcroft } 36764a0df2efSAndy Whitcroft 367703df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 367803df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 367903df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 368003df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 368103df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 368203df4b51SAndy Whitcroft "$1(NULL) is safe this check is probably not required\n" . $hereprev); 36834c432a8fSGreg Kroah-Hartman } 36844c432a8fSGreg Kroah-Hartman } 3685f0a594c1SAndy Whitcroft 36861a15a250SPatrick Pannuto# prefer usleep_range over udelay 368737581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 36881a15a250SPatrick Pannuto # ignore udelay's < 10, however 368937581c28SBruce Allan if (! ($1 < 10) ) { 3690000d1cc1SJoe Perches CHK("USLEEP_RANGE", 3691000d1cc1SJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line); 36921a15a250SPatrick Pannuto } 36931a15a250SPatrick Pannuto } 36941a15a250SPatrick Pannuto 369509ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 369609ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 369709ef8725SPatrick Pannuto if ($1 < 20) { 3698000d1cc1SJoe Perches WARN("MSLEEP", 3699000d1cc1SJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line); 370009ef8725SPatrick Pannuto } 370109ef8725SPatrick Pannuto } 370209ef8725SPatrick Pannuto 370336ec1939SJoe Perches# check for comparisons of jiffies 370436ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 370536ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 370636ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 370736ec1939SJoe Perches } 370836ec1939SJoe Perches 37099d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 37109d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 37119d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 37129d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 37139d7a34a5SJoe Perches } 37149d7a34a5SJoe Perches 371500df344fSAndy Whitcroft# warn about #ifdefs in C files 3716c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 371700df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 371800df344fSAndy Whitcroft# print "$herecurr"; 371900df344fSAndy Whitcroft# $clean = 0; 372000df344fSAndy Whitcroft# } 372100df344fSAndy Whitcroft 372222f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 3723c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 37243705ce5bSJoe Perches if (ERROR("SPACING", 37253705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 37263705ce5bSJoe Perches $fix) { 37273705ce5bSJoe Perches $fixed[$linenr - 1] =~ 37283705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 37293705ce5bSJoe Perches } 37303705ce5bSJoe Perches 373122f2a2efSAndy Whitcroft } 373222f2a2efSAndy Whitcroft 37334a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 3734171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 3735171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 37364a0df2efSAndy Whitcroft my $which = $1; 37374a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3738000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 3739000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 37404a0df2efSAndy Whitcroft } 37414a0df2efSAndy Whitcroft } 37424a0df2efSAndy Whitcroft# check for memory barriers without a comment. 37434a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 37444a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3745000d1cc1SJoe Perches CHK("MEMORY_BARRIER", 3746000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 37474a0df2efSAndy Whitcroft } 37484a0df2efSAndy Whitcroft } 37494a0df2efSAndy Whitcroft# check of hardware specific defines 3750c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 3751000d1cc1SJoe Perches CHK("ARCH_DEFINES", 3752000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 37530a920b5bSAndy Whitcroft } 3754653d4876SAndy Whitcroft 3755d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 3756d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 3757000d1cc1SJoe Perches WARN("STORAGE_CLASS", 3758000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 3759d4977c78STobias Klauser } 3760d4977c78STobias Klauser 3761de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 3762de7d4f0eSAndy Whitcroft# storage class and type. 37639c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 37649c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 3765000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 3766000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 3767de7d4f0eSAndy Whitcroft } 3768de7d4f0eSAndy Whitcroft 37698905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 37708905a67cSAndy Whitcroft if ($line =~ /\b(__inline__|__inline)\b/) { 3771d5e616fcSJoe Perches if (WARN("INLINE", 3772d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 3773d5e616fcSJoe Perches $fix) { 3774d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/; 3775d5e616fcSJoe Perches 3776d5e616fcSJoe Perches } 37778905a67cSAndy Whitcroft } 37788905a67cSAndy Whitcroft 37793d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 37803d130fd0SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 3781000d1cc1SJoe Perches WARN("PREFER_PACKED", 3782000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 37833d130fd0SJoe Perches } 37843d130fd0SJoe Perches 378539b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 378639b7e287SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 3787000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 3788000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 378939b7e287SJoe Perches } 379039b7e287SJoe Perches 37915f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 37925f14d3bdSJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 3793d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 3794d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 3795d5e616fcSJoe Perches $fix) { 3796d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 3797d5e616fcSJoe Perches 3798d5e616fcSJoe Perches } 37995f14d3bdSJoe Perches } 38005f14d3bdSJoe Perches 38016061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 38026061d949SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 3803d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 3804d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 3805d5e616fcSJoe Perches $fix) { 3806d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 3807d5e616fcSJoe Perches } 38086061d949SJoe Perches } 38096061d949SJoe Perches 38108f53a9b8SJoe Perches# check for sizeof(&) 38118f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 3812000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 3813000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 38148f53a9b8SJoe Perches } 38158f53a9b8SJoe Perches 381666c80b60SJoe Perches# check for sizeof without parenthesis 381766c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 3818d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 3819d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 3820d5e616fcSJoe Perches $fix) { 3821d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 3822d5e616fcSJoe Perches } 382366c80b60SJoe Perches } 382466c80b60SJoe Perches 3825428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 3826428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 3827000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 3828000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 3829428e2fdcSJoe Perches } 3830428e2fdcSJoe Perches 383188982feaSJoe Perches# check for struct spinlock declarations 383288982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 383388982feaSJoe Perches WARN("USE_SPINLOCK_T", 383488982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 383588982feaSJoe Perches } 383688982feaSJoe Perches 3837a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 3838a6962d72SJoe Perches if ($line =~ /\bseq_printf\s*\(/) { 3839a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 3840a6962d72SJoe Perches if ($fmt !~ /[^\\]\%/) { 3841d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 3842d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 3843d5e616fcSJoe Perches $fix) { 3844d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/; 3845d5e616fcSJoe Perches } 3846a6962d72SJoe Perches } 3847a6962d72SJoe Perches } 3848a6962d72SJoe Perches 3849554e165cSAndy Whitcroft# Check for misused memsets 3850d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3851d1fe9c09SJoe Perches defined $stat && 3852d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 3853554e165cSAndy Whitcroft 3854d7c76ba7SJoe Perches my $ms_addr = $2; 3855d1fe9c09SJoe Perches my $ms_val = $7; 3856d1fe9c09SJoe Perches my $ms_size = $12; 3857d7c76ba7SJoe Perches 3858554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 3859554e165cSAndy Whitcroft ERROR("MEMSET", 3860d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 3861554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 3862554e165cSAndy Whitcroft WARN("MEMSET", 3863d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 3864d7c76ba7SJoe Perches } 3865d7c76ba7SJoe Perches } 3866d7c76ba7SJoe Perches 3867d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 3868d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3869d1fe9c09SJoe Perches defined $stat && 3870d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 3871d1fe9c09SJoe Perches if (defined $2 || defined $7) { 3872d7c76ba7SJoe Perches my $call = $1; 3873d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 3874d7c76ba7SJoe Perches my $arg1 = $3; 3875d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 3876d1fe9c09SJoe Perches my $arg2 = $8; 3877d7c76ba7SJoe Perches my $cast; 3878d7c76ba7SJoe Perches 3879d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 3880d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 3881d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 3882d7c76ba7SJoe Perches $cast = $cast1; 3883d7c76ba7SJoe Perches } else { 3884d7c76ba7SJoe Perches $cast = $cast2; 3885d7c76ba7SJoe Perches } 3886d7c76ba7SJoe Perches WARN("MINMAX", 3887d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 3888554e165cSAndy Whitcroft } 3889554e165cSAndy Whitcroft } 3890554e165cSAndy Whitcroft 38914a273195SJoe Perches# check usleep_range arguments 38924a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 38934a273195SJoe Perches defined $stat && 38944a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 38954a273195SJoe Perches my $min = $1; 38964a273195SJoe Perches my $max = $7; 38974a273195SJoe Perches if ($min eq $max) { 38984a273195SJoe Perches WARN("USLEEP_RANGE", 38994a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 39004a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 39014a273195SJoe Perches $min > $max) { 39024a273195SJoe Perches WARN("USLEEP_RANGE", 39034a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 39044a273195SJoe Perches } 39054a273195SJoe Perches } 39064a273195SJoe Perches 390770dc8a48SJoe Perches# check for new externs in .h files. 390870dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 390970dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 391070dc8a48SJoe Perches if (WARN("AVOID_EXTERNS", 391170dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 391270dc8a48SJoe Perches $fix) { 391370dc8a48SJoe Perches $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 391470dc8a48SJoe Perches } 391570dc8a48SJoe Perches } 391670dc8a48SJoe Perches 3917de7d4f0eSAndy Whitcroft# check for new externs in .c files. 3918171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 3919c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 3920171ae1a4SAndy Whitcroft { 3921c45dcabdSAndy Whitcroft my $function_name = $1; 3922c45dcabdSAndy Whitcroft my $paren_space = $2; 3923171ae1a4SAndy Whitcroft 3924171ae1a4SAndy Whitcroft my $s = $stat; 3925171ae1a4SAndy Whitcroft if (defined $cond) { 3926171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 3927171ae1a4SAndy Whitcroft } 3928c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 3929c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 3930c45dcabdSAndy Whitcroft { 3931000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 3932000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 3933de7d4f0eSAndy Whitcroft } 3934de7d4f0eSAndy Whitcroft 3935171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 3936000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 3937000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 3938171ae1a4SAndy Whitcroft } 39399c9ba34eSAndy Whitcroft 39409c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 39419c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 39429c9ba34eSAndy Whitcroft { 3943000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 3944000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 3945171ae1a4SAndy Whitcroft } 3946171ae1a4SAndy Whitcroft 3947de7d4f0eSAndy Whitcroft# checks for new __setup's 3948de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 3949de7d4f0eSAndy Whitcroft my $name = $1; 3950de7d4f0eSAndy Whitcroft 3951de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 3952000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 3953000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 3954de7d4f0eSAndy Whitcroft } 3955653d4876SAndy Whitcroft } 39569c0ca6f9SAndy Whitcroft 39579c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 3958caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 3959000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 3960000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 39619c0ca6f9SAndy Whitcroft } 396213214adfSAndy Whitcroft 3963a640d25cSJoe Perches# alloc style 3964a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 3965a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 3966a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 3967a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 3968a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 3969a640d25cSJoe Perches } 3970a640d25cSJoe Perches 3971972fdea2SJoe Perches# check for krealloc arg reuse 3972972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 3973972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 3974972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 3975972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 3976972fdea2SJoe Perches } 3977972fdea2SJoe Perches 39785ce59ae0SJoe Perches# check for alloc argument mismatch 39795ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 39805ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 39815ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 39825ce59ae0SJoe Perches } 39835ce59ae0SJoe Perches 3984caf2a54fSJoe Perches# check for multiple semicolons 3985caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 3986d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 3987d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 3988d5e616fcSJoe Perches $fix) { 3989d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g; 3990d5e616fcSJoe Perches } 3991d1e2ad07SJoe Perches } 3992d1e2ad07SJoe Perches 3993d1e2ad07SJoe Perches# check for switch/default statements without a break; 3994d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 3995d1e2ad07SJoe Perches defined $stat && 3996d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 3997d1e2ad07SJoe Perches my $ctx = ''; 3998d1e2ad07SJoe Perches my $herectx = $here . "\n"; 3999d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 4000d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4001d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4002d1e2ad07SJoe Perches } 4003d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 4004d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 4005caf2a54fSJoe Perches } 4006caf2a54fSJoe Perches 400713214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 4008d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 4009d5e616fcSJoe Perches if (WARN("USE_FUNC", 4010d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 4011d5e616fcSJoe Perches $fix) { 4012d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g; 4013d5e616fcSJoe Perches } 401413214adfSAndy Whitcroft } 4015773647a0SAndy Whitcroft 40162c92488aSJoe Perches# check for use of yield() 40172c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 40182c92488aSJoe Perches WARN("YIELD", 40192c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 40202c92488aSJoe Perches } 40212c92488aSJoe Perches 4022179f8f40SJoe Perches# check for comparisons against true and false 4023179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 4024179f8f40SJoe Perches my $lead = $1; 4025179f8f40SJoe Perches my $arg = $2; 4026179f8f40SJoe Perches my $test = $3; 4027179f8f40SJoe Perches my $otype = $4; 4028179f8f40SJoe Perches my $trail = $5; 4029179f8f40SJoe Perches my $op = "!"; 4030179f8f40SJoe Perches 4031179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 4032179f8f40SJoe Perches 4033179f8f40SJoe Perches my $type = lc($otype); 4034179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 4035179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 4036179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 4037179f8f40SJoe Perches $op = ""; 4038179f8f40SJoe Perches } 4039179f8f40SJoe Perches 4040179f8f40SJoe Perches CHK("BOOL_COMPARISON", 4041179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 4042179f8f40SJoe Perches 4043179f8f40SJoe Perches## maybe suggesting a correct construct would better 4044179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 4045179f8f40SJoe Perches 4046179f8f40SJoe Perches } 4047179f8f40SJoe Perches } 4048179f8f40SJoe Perches 40494882720bSThomas Gleixner# check for semaphores initialized locked 40504882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 4051000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 4052000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 4053773647a0SAndy Whitcroft } 40546712d858SJoe Perches 405567d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 405667d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 4057000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 405867d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 4059773647a0SAndy Whitcroft } 40606712d858SJoe Perches 4061f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please 4062f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 4063000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 4064000d1cc1SJoe Perches "please use device_initcall() instead of __initcall()\n" . $herecurr); 4065f3db6639SMichael Ellerman } 40666712d858SJoe Perches 406779404849SEmese Revfy# check for various ops structs, ensure they are const. 406879404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 406979404849SEmese Revfy address_space_operations| 407079404849SEmese Revfy backlight_ops| 407179404849SEmese Revfy block_device_operations| 407279404849SEmese Revfy dentry_operations| 407379404849SEmese Revfy dev_pm_ops| 407479404849SEmese Revfy dma_map_ops| 407579404849SEmese Revfy extent_io_ops| 407679404849SEmese Revfy file_lock_operations| 407779404849SEmese Revfy file_operations| 407879404849SEmese Revfy hv_ops| 407979404849SEmese Revfy ide_dma_ops| 408079404849SEmese Revfy intel_dvo_dev_ops| 408179404849SEmese Revfy item_operations| 408279404849SEmese Revfy iwl_ops| 408379404849SEmese Revfy kgdb_arch| 408479404849SEmese Revfy kgdb_io| 408579404849SEmese Revfy kset_uevent_ops| 408679404849SEmese Revfy lock_manager_operations| 408779404849SEmese Revfy microcode_ops| 408879404849SEmese Revfy mtrr_ops| 408979404849SEmese Revfy neigh_ops| 409079404849SEmese Revfy nlmsvc_binding| 409179404849SEmese Revfy pci_raw_ops| 409279404849SEmese Revfy pipe_buf_operations| 409379404849SEmese Revfy platform_hibernation_ops| 409479404849SEmese Revfy platform_suspend_ops| 409579404849SEmese Revfy proto_ops| 409679404849SEmese Revfy rpc_pipe_ops| 409779404849SEmese Revfy seq_operations| 409879404849SEmese Revfy snd_ac97_build_ops| 409979404849SEmese Revfy soc_pcmcia_socket_ops| 410079404849SEmese Revfy stacktrace_ops| 410179404849SEmese Revfy sysfs_ops| 410279404849SEmese Revfy tty_operations| 410379404849SEmese Revfy usb_mon_operations| 410479404849SEmese Revfy wd_ops}x; 41056903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 410679404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 4107000d1cc1SJoe Perches WARN("CONST_STRUCT", 4108000d1cc1SJoe Perches "struct $1 should normally be const\n" . 41096903ffb2SAndy Whitcroft $herecurr); 41102b6db5cbSAndy Whitcroft } 4111773647a0SAndy Whitcroft 4112773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 4113773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 4114773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 4115c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 4116c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 4117171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 4118171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 4119171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 4120773647a0SAndy Whitcroft { 4121000d1cc1SJoe Perches WARN("NR_CPUS", 4122000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 4123773647a0SAndy Whitcroft } 41249c9ba34eSAndy Whitcroft 41259c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 41269c9ba34eSAndy Whitcroft my $string; 41279c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 41289c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 41292a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 41309c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 4131000d1cc1SJoe Perches WARN("PRINTF_L", 4132000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 41339c9ba34eSAndy Whitcroft last; 41349c9ba34eSAndy Whitcroft } 41359c9ba34eSAndy Whitcroft } 4136691d77b6SAndy Whitcroft 4137691d77b6SAndy Whitcroft# whine mightly about in_atomic 4138691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 4139691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 4140000d1cc1SJoe Perches ERROR("IN_ATOMIC", 4141000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 4142f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 4143000d1cc1SJoe Perches WARN("IN_ATOMIC", 4144000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 4145691d77b6SAndy Whitcroft } 4146691d77b6SAndy Whitcroft } 41471704f47bSPeter Zijlstra 41481704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 41491704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 41501704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 41511704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 41521704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 41531704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 4154000d1cc1SJoe Perches ERROR("LOCKDEP", 4155000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 41561704f47bSPeter Zijlstra } 41571704f47bSPeter Zijlstra } 415888f8831cSDave Jones 415988f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 416088f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 4161000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 4162000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 416388f8831cSDave Jones } 416413214adfSAndy Whitcroft } 416513214adfSAndy Whitcroft 416613214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 416713214adfSAndy Whitcroft # so just keep quiet. 416813214adfSAndy Whitcroft if ($#rawlines == -1) { 416913214adfSAndy Whitcroft exit(0); 41700a920b5bSAndy Whitcroft } 41710a920b5bSAndy Whitcroft 41728905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 41738905a67cSAndy Whitcroft # things that appear to be patches. 41748905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 41758905a67cSAndy Whitcroft exit(0); 41768905a67cSAndy Whitcroft } 41778905a67cSAndy Whitcroft 41788905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 41798905a67cSAndy Whitcroft # just keep quiet. 41808905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 41818905a67cSAndy Whitcroft exit(0); 41828905a67cSAndy Whitcroft } 41838905a67cSAndy Whitcroft 41848905a67cSAndy Whitcroft if (!$is_patch) { 4185000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 4186000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 41870a920b5bSAndy Whitcroft } 41880a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 4189000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 4190000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 41910a920b5bSAndy Whitcroft } 41920a920b5bSAndy Whitcroft 4193f0a594c1SAndy Whitcroft print report_dump(); 419413214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 419513214adfSAndy Whitcroft print "$filename " if ($summary_file); 41966c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 41976c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 41986c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 41998905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 42006c72ffaaSAndy Whitcroft } 42018905a67cSAndy Whitcroft 4202d2c0a235SAndy Whitcroft if ($quiet == 0) { 4203d1fe9c09SJoe Perches 4204d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 4205d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 4206d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 4207d1fe9c09SJoe Perches } 4208d1fe9c09SJoe Perches 4209d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 4210d2c0a235SAndy Whitcroft # then suggest that. 4211d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 4212d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 4213d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 4214b0781216SMike Frysinger $rpt_cleaners = 0; 4215d2c0a235SAndy Whitcroft } 4216d2c0a235SAndy Whitcroft } 4217d2c0a235SAndy Whitcroft 4218*91bfe484SJoe Perches hash_show_words(\%use_type, "Used"); 4219*91bfe484SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 4220000d1cc1SJoe Perches 42213705ce5bSJoe Perches if ($clean == 0 && $fix && "@rawlines" ne "@fixed") { 42223705ce5bSJoe Perches my $newfile = $filename . ".EXPERIMENTAL-checkpatch-fixes"; 42233705ce5bSJoe Perches my $linecount = 0; 42243705ce5bSJoe Perches my $f; 42253705ce5bSJoe Perches 42263705ce5bSJoe Perches open($f, '>', $newfile) 42273705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 42283705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 42293705ce5bSJoe Perches $linecount++; 42303705ce5bSJoe Perches if ($file) { 42313705ce5bSJoe Perches if ($linecount > 3) { 42323705ce5bSJoe Perches $fixed_line =~ s/^\+//; 42333705ce5bSJoe Perches print $f $fixed_line. "\n"; 42343705ce5bSJoe Perches } 42353705ce5bSJoe Perches } else { 42363705ce5bSJoe Perches print $f $fixed_line . "\n"; 42373705ce5bSJoe Perches } 42383705ce5bSJoe Perches } 42393705ce5bSJoe Perches close($f); 42403705ce5bSJoe Perches 42413705ce5bSJoe Perches if (!$quiet) { 42423705ce5bSJoe Perches print << "EOM"; 42433705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 42443705ce5bSJoe Perches 42453705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 42463705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 42473705ce5bSJoe Perches 42483705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 42493705ce5bSJoe PerchesNo warranties, expressed or implied... 42503705ce5bSJoe Perches 42513705ce5bSJoe PerchesEOM 42523705ce5bSJoe Perches } 42533705ce5bSJoe Perches } 42543705ce5bSJoe Perches 42550a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 4256c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 42570a920b5bSAndy Whitcroft } 42580a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 4259000d1cc1SJoe Perches print << "EOM"; 4260000d1cc1SJoe Perches$vname has style problems, please review. 4261000d1cc1SJoe Perches 4262000d1cc1SJoe PerchesIf any of these errors are false positives, please report 4263000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 4264000d1cc1SJoe PerchesEOM 42650a920b5bSAndy Whitcroft } 426613214adfSAndy Whitcroft 42670a920b5bSAndy Whitcroft return $clean; 42680a920b5bSAndy Whitcroft} 4269