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; 90a920b5bSAndy Whitcroft 100a920b5bSAndy Whitcroftmy $P = $0; 1100df344fSAndy Whitcroft$P =~ s@.*/@@g; 120a920b5bSAndy Whitcroft 13000d1cc1SJoe Perchesmy $V = '0.32'; 140a920b5bSAndy Whitcroft 150a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 160a920b5bSAndy Whitcroft 170a920b5bSAndy Whitcroftmy $quiet = 0; 180a920b5bSAndy Whitcroftmy $tree = 1; 190a920b5bSAndy Whitcroftmy $chk_signoff = 1; 200a920b5bSAndy Whitcroftmy $chk_patch = 1; 21773647a0SAndy Whitcroftmy $tst_only; 226c72ffaaSAndy Whitcroftmy $emacs = 0; 238905a67cSAndy Whitcroftmy $terse = 0; 246c72ffaaSAndy Whitcroftmy $file = 0; 256c72ffaaSAndy Whitcroftmy $check = 0; 268905a67cSAndy Whitcroftmy $summary = 1; 278905a67cSAndy Whitcroftmy $mailback = 0; 2813214adfSAndy Whitcroftmy $summary_file = 0; 29000d1cc1SJoe Perchesmy $show_types = 0; 306c72ffaaSAndy Whitcroftmy $root; 31c2fdda0dSAndy Whitcroftmy %debug; 32000d1cc1SJoe Perchesmy %ignore_type = (); 33000d1cc1SJoe Perchesmy @ignore = (); 3477f5b10aSHannes Edermy $help = 0; 35000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 3677f5b10aSHannes Eder 3777f5b10aSHannes Edersub help { 3877f5b10aSHannes Eder my ($exitcode) = @_; 3977f5b10aSHannes Eder 4077f5b10aSHannes Eder print << "EOM"; 4177f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 4277f5b10aSHannes EderVersion: $V 4377f5b10aSHannes Eder 4477f5b10aSHannes EderOptions: 4577f5b10aSHannes Eder -q, --quiet quiet 4677f5b10aSHannes Eder --no-tree run without a kernel tree 4777f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 4877f5b10aSHannes Eder --patch treat FILE as patchfile (default) 4977f5b10aSHannes Eder --emacs emacs compile window format 5077f5b10aSHannes Eder --terse one line per report 5177f5b10aSHannes Eder -f, --file treat FILE as regular source file 5277f5b10aSHannes Eder --subjective, --strict enable more subjective tests 53000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 54000d1cc1SJoe Perches --show-types show the message "types" in the output 5577f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 5677f5b10aSHannes Eder --no-summary suppress the per-file summary 5777f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 5877f5b10aSHannes Eder --summary-file include the filename in summary 5977f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 6077f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 6177f5b10aSHannes Eder is all off) 6277f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 6377f5b10aSHannes Eder literally 6477f5b10aSHannes Eder -h, --help, --version display this help and exit 6577f5b10aSHannes Eder 6677f5b10aSHannes EderWhen FILE is - read standard input. 6777f5b10aSHannes EderEOM 6877f5b10aSHannes Eder 6977f5b10aSHannes Eder exit($exitcode); 7077f5b10aSHannes Eder} 7177f5b10aSHannes Eder 72000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 73000d1cc1SJoe Perchesif (-f $conf) { 74000d1cc1SJoe Perches my @conf_args; 75000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 76000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 77000d1cc1SJoe Perches 78000d1cc1SJoe Perches while (<$conffile>) { 79000d1cc1SJoe Perches my $line = $_; 80000d1cc1SJoe Perches 81000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 82000d1cc1SJoe Perches $line =~ s/^\s*//g; 83000d1cc1SJoe Perches $line =~ s/\s+/ /g; 84000d1cc1SJoe Perches 85000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 86000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 87000d1cc1SJoe Perches 88000d1cc1SJoe Perches my @words = split(" ", $line); 89000d1cc1SJoe Perches foreach my $word (@words) { 90000d1cc1SJoe Perches last if ($word =~ m/^#/); 91000d1cc1SJoe Perches push (@conf_args, $word); 92000d1cc1SJoe Perches } 93000d1cc1SJoe Perches } 94000d1cc1SJoe Perches close($conffile); 95000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 96000d1cc1SJoe Perches} 97000d1cc1SJoe Perches 980a920b5bSAndy WhitcroftGetOptions( 996c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1000a920b5bSAndy Whitcroft 'tree!' => \$tree, 1010a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1020a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1036c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1048905a67cSAndy Whitcroft 'terse!' => \$terse, 10577f5b10aSHannes Eder 'f|file!' => \$file, 1066c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1076c72ffaaSAndy Whitcroft 'strict!' => \$check, 108000d1cc1SJoe Perches 'ignore=s' => \@ignore, 109000d1cc1SJoe Perches 'show-types!' => \$show_types, 1106c72ffaaSAndy Whitcroft 'root=s' => \$root, 1118905a67cSAndy Whitcroft 'summary!' => \$summary, 1128905a67cSAndy Whitcroft 'mailback!' => \$mailback, 11313214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 11413214adfSAndy Whitcroft 115c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 116773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 11777f5b10aSHannes Eder 'h|help' => \$help, 11877f5b10aSHannes Eder 'version' => \$help 11977f5b10aSHannes Eder) or help(1); 12077f5b10aSHannes Eder 12177f5b10aSHannes Ederhelp(0) if ($help); 1220a920b5bSAndy Whitcroft 1230a920b5bSAndy Whitcroftmy $exit = 0; 1240a920b5bSAndy Whitcroft 1250a920b5bSAndy Whitcroftif ($#ARGV < 0) { 12677f5b10aSHannes Eder print "$P: no input files\n"; 1270a920b5bSAndy Whitcroft exit(1); 1280a920b5bSAndy Whitcroft} 1290a920b5bSAndy Whitcroft 130000d1cc1SJoe Perches@ignore = split(/,/, join(',',@ignore)); 131000d1cc1SJoe Perchesforeach my $word (@ignore) { 132000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 133000d1cc1SJoe Perches $word =~ s/^\s*//g; 134000d1cc1SJoe Perches $word =~ s/\s+/ /g; 135000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 136000d1cc1SJoe Perches 137000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 138000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 139000d1cc1SJoe Perches 140000d1cc1SJoe Perches $ignore_type{$word}++; 141000d1cc1SJoe Perches} 142000d1cc1SJoe Perches 143c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 144c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 1457429c690SAndy Whitcroftmy $dbg_type = 0; 146a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 147c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 14821caa13cSAndy Whitcroft ## no critic 14921caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 15021caa13cSAndy Whitcroft die "$@" if ($@); 151c2fdda0dSAndy Whitcroft} 152c2fdda0dSAndy Whitcroft 153d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 154d2c0a235SAndy Whitcroft 1558905a67cSAndy Whitcroftif ($terse) { 1568905a67cSAndy Whitcroft $emacs = 1; 1578905a67cSAndy Whitcroft $quiet++; 1588905a67cSAndy Whitcroft} 1598905a67cSAndy Whitcroft 1606c72ffaaSAndy Whitcroftif ($tree) { 1616c72ffaaSAndy Whitcroft if (defined $root) { 1626c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 1636c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 1646c72ffaaSAndy Whitcroft } 1656c72ffaaSAndy Whitcroft } else { 1666c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 1676c72ffaaSAndy Whitcroft $root = '.'; 1686c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 1696c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 1706c72ffaaSAndy Whitcroft $root = $1; 1716c72ffaaSAndy Whitcroft } 1726c72ffaaSAndy Whitcroft } 1736c72ffaaSAndy Whitcroft 1746c72ffaaSAndy Whitcroft if (!defined $root) { 1750a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 1760a920b5bSAndy Whitcroft exit(2); 1770a920b5bSAndy Whitcroft } 1786c72ffaaSAndy Whitcroft} 1796c72ffaaSAndy Whitcroft 1806c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 1816c72ffaaSAndy Whitcroft 1822ceb532bSAndy Whitcroftour $Ident = qr{ 1832ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 1842ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 1852ceb532bSAndy Whitcroft }x; 1866c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 1876c72ffaaSAndy Whitcroftour $Sparse = qr{ 1886c72ffaaSAndy Whitcroft __user| 1896c72ffaaSAndy Whitcroft __kernel| 1906c72ffaaSAndy Whitcroft __force| 1916c72ffaaSAndy Whitcroft __iomem| 1926c72ffaaSAndy Whitcroft __must_check| 1936c72ffaaSAndy Whitcroft __init_refok| 194417495edSAndy Whitcroft __kprobes| 195165e72a6SSven Eckelmann __ref| 196165e72a6SSven Eckelmann __rcu 1976c72ffaaSAndy Whitcroft }x; 19852131292SWolfram Sang 19952131292SWolfram Sang# Notes to $Attribute: 20052131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 2016c72ffaaSAndy Whitcroftour $Attribute = qr{ 2026c72ffaaSAndy Whitcroft const| 20303f1df7dSJoe Perches __percpu| 20403f1df7dSJoe Perches __nocast| 20503f1df7dSJoe Perches __safe| 20603f1df7dSJoe Perches __bitwise__| 20703f1df7dSJoe Perches __packed__| 20803f1df7dSJoe Perches __packed2__| 20903f1df7dSJoe Perches __naked| 21003f1df7dSJoe Perches __maybe_unused| 21103f1df7dSJoe Perches __always_unused| 21203f1df7dSJoe Perches __noreturn| 21303f1df7dSJoe Perches __used| 21403f1df7dSJoe Perches __cold| 21503f1df7dSJoe Perches __noclone| 21603f1df7dSJoe Perches __deprecated| 2176c72ffaaSAndy Whitcroft __read_mostly| 2186c72ffaaSAndy Whitcroft __kprobes| 21952131292SWolfram Sang __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)| 22024e1d81aSAndy Whitcroft ____cacheline_aligned| 22124e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 2225fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 2235fe3af11SAndy Whitcroft __weak 2246c72ffaaSAndy Whitcroft }x; 225c45dcabdSAndy Whitcroftour $Modifier; 2266c72ffaaSAndy Whitcroftour $Inline = qr{inline|__always_inline|noinline}; 2276c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 2286c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 2296c72ffaaSAndy Whitcroft 230d7c76ba7SJoe Perchesour $Constant = qr{(?i:(?:[0-9]+|0x[0-9a-f]+)[ul]*)}; 2316c72ffaaSAndy Whitcroftour $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)}; 23286f9d059SAndy Whitcroftour $Compare = qr{<=|>=|==|!=|<|>}; 2336c72ffaaSAndy Whitcroftour $Operators = qr{ 2346c72ffaaSAndy Whitcroft <=|>=|==|!=| 2356c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 236c2fdda0dSAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|% 2376c72ffaaSAndy Whitcroft }x; 2386c72ffaaSAndy Whitcroft 2398905a67cSAndy Whitcroftour $NonptrType; 2408905a67cSAndy Whitcroftour $Type; 2418905a67cSAndy Whitcroftour $Declare; 2428905a67cSAndy Whitcroft 24315662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 24415662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 245171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 246171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 247171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 248171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 249171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 250171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 251171ae1a4SAndy Whitcroft}x; 252171ae1a4SAndy Whitcroft 25315662b3eSJoe Perchesour $UTF8 = qr{ 25415662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 25515662b3eSJoe Perches | $NON_ASCII_UTF8 25615662b3eSJoe Perches}x; 25715662b3eSJoe Perches 2588ed22cadSAndy Whitcroftour $typeTypedefs = qr{(?x: 259fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 2608ed22cadSAndy Whitcroft atomic_t 2618ed22cadSAndy Whitcroft)}; 2628ed22cadSAndy Whitcroft 263691e669bSJoe Perchesour $logFunctions = qr{(?x: 2646e60c02eSJoe Perches printk(?:_ratelimited|_once|)| 2656e60c02eSJoe Perches [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 2666e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 267b0531722SJoe Perches panic| 268b0531722SJoe Perches MODULE_[A-Z_]+ 269691e669bSJoe Perches)}; 270691e669bSJoe Perches 27120112475SJoe Perchesour $signature_tags = qr{(?xi: 27220112475SJoe Perches Signed-off-by:| 27320112475SJoe Perches Acked-by:| 27420112475SJoe Perches Tested-by:| 27520112475SJoe Perches Reviewed-by:| 27620112475SJoe Perches Reported-by:| 27720112475SJoe Perches To:| 27820112475SJoe Perches Cc: 27920112475SJoe Perches)}; 28020112475SJoe Perches 2818905a67cSAndy Whitcroftour @typeList = ( 2828905a67cSAndy Whitcroft qr{void}, 283c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?char}, 284c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?short}, 285c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?int}, 286c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long}, 287c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+int}, 288c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long}, 289c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long\s+int}, 2908905a67cSAndy Whitcroft qr{unsigned}, 2918905a67cSAndy Whitcroft qr{float}, 2928905a67cSAndy Whitcroft qr{double}, 2938905a67cSAndy Whitcroft qr{bool}, 2948905a67cSAndy Whitcroft qr{struct\s+$Ident}, 2958905a67cSAndy Whitcroft qr{union\s+$Ident}, 2968905a67cSAndy Whitcroft qr{enum\s+$Ident}, 2978905a67cSAndy Whitcroft qr{${Ident}_t}, 2988905a67cSAndy Whitcroft qr{${Ident}_handler}, 2998905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 3008905a67cSAndy Whitcroft); 301c45dcabdSAndy Whitcroftour @modifierList = ( 302c45dcabdSAndy Whitcroft qr{fastcall}, 303c45dcabdSAndy Whitcroft); 3048905a67cSAndy Whitcroft 3057840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 3067840a94cSWolfram Sang irq| 3077840a94cSWolfram Sang memory 3087840a94cSWolfram Sang)}; 3097840a94cSWolfram Sang# memory.h: ARM has a custom one 3107840a94cSWolfram Sang 3118905a67cSAndy Whitcroftsub build_types { 312d2172eb5SAndy Whitcroft my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; 313d2172eb5SAndy Whitcroft my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; 314c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 3158905a67cSAndy Whitcroft $NonptrType = qr{ 316d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 317cf655043SAndy Whitcroft (?: 318c45dcabdSAndy Whitcroft (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)| 3198ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 320c45dcabdSAndy Whitcroft (?:${all}\b) 321cf655043SAndy Whitcroft ) 322c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 3238905a67cSAndy Whitcroft }x; 3248905a67cSAndy Whitcroft $Type = qr{ 325c45dcabdSAndy Whitcroft $NonptrType 32665863862SAndy Whitcroft (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)? 327c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 3288905a67cSAndy Whitcroft }x; 3298905a67cSAndy Whitcroft $Declare = qr{(?:$Storage\s+)?$Type}; 3308905a67cSAndy Whitcroft} 3318905a67cSAndy Whitcroftbuild_types(); 3326c72ffaaSAndy Whitcroft 3337d2367afSJoe Perchesour $match_balanced_parentheses = qr/(\((?:[^\(\)]+|(-1))*\))/; 3347d2367afSJoe Perches 3357d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 3367d2367afSJoe Perchesour $LvalOrFunc = qr{($Lval)\s*($match_balanced_parentheses{0,1})\s*}; 337d7c76ba7SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)}; 3387d2367afSJoe Perches 3397d2367afSJoe Perchessub deparenthesize { 3407d2367afSJoe Perches my ($string) = @_; 3417d2367afSJoe Perches return "" if (!defined($string)); 3427d2367afSJoe Perches $string =~ s@^\s*\(\s*@@g; 3437d2367afSJoe Perches $string =~ s@\s*\)\s*$@@g; 3447d2367afSJoe Perches $string =~ s@\s+@ @g; 3457d2367afSJoe Perches return $string; 3467d2367afSJoe Perches} 3477d2367afSJoe Perches 3486c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 3490a920b5bSAndy Whitcroft 3504a0df2efSAndy Whitcroftmy @dep_includes = (); 3514a0df2efSAndy Whitcroftmy @dep_functions = (); 3526c72ffaaSAndy Whitcroftmy $removal = "Documentation/feature-removal-schedule.txt"; 3536c72ffaaSAndy Whitcroftif ($tree && -f "$root/$removal") { 35421caa13cSAndy Whitcroft open(my $REMOVE, '<', "$root/$removal") || 3556c72ffaaSAndy Whitcroft die "$P: $removal: open failed - $!\n"; 35621caa13cSAndy Whitcroft while (<$REMOVE>) { 357f0a594c1SAndy Whitcroft if (/^Check:\s+(.*\S)/) { 358f0a594c1SAndy Whitcroft for my $entry (split(/[, ]+/, $1)) { 359f0a594c1SAndy Whitcroft if ($entry =~ m@include/(.*)@) { 3604a0df2efSAndy Whitcroft push(@dep_includes, $1); 3614a0df2efSAndy Whitcroft 362f0a594c1SAndy Whitcroft } elsif ($entry !~ m@/@) { 363f0a594c1SAndy Whitcroft push(@dep_functions, $entry); 364f0a594c1SAndy Whitcroft } 3654a0df2efSAndy Whitcroft } 3660a920b5bSAndy Whitcroft } 3670a920b5bSAndy Whitcroft } 36821caa13cSAndy Whitcroft close($REMOVE); 3690a920b5bSAndy Whitcroft} 3700a920b5bSAndy Whitcroft 37100df344fSAndy Whitcroftmy @rawlines = (); 372c2fdda0dSAndy Whitcroftmy @lines = (); 373c2fdda0dSAndy Whitcroftmy $vname; 3746c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 37521caa13cSAndy Whitcroft my $FILE; 3766c72ffaaSAndy Whitcroft if ($file) { 37721caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 3786c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 37921caa13cSAndy Whitcroft } elsif ($filename eq '-') { 38021caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 3816c72ffaaSAndy Whitcroft } else { 38221caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 3836c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 3846c72ffaaSAndy Whitcroft } 385c2fdda0dSAndy Whitcroft if ($filename eq '-') { 386c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 387c2fdda0dSAndy Whitcroft } else { 388c2fdda0dSAndy Whitcroft $vname = $filename; 389c2fdda0dSAndy Whitcroft } 39021caa13cSAndy Whitcroft while (<$FILE>) { 3910a920b5bSAndy Whitcroft chomp; 39200df344fSAndy Whitcroft push(@rawlines, $_); 3936c72ffaaSAndy Whitcroft } 39421caa13cSAndy Whitcroft close($FILE); 395c2fdda0dSAndy Whitcroft if (!process($filename)) { 3960a920b5bSAndy Whitcroft $exit = 1; 3970a920b5bSAndy Whitcroft } 39800df344fSAndy Whitcroft @rawlines = (); 39913214adfSAndy Whitcroft @lines = (); 4000a920b5bSAndy Whitcroft} 4010a920b5bSAndy Whitcroft 4020a920b5bSAndy Whitcroftexit($exit); 4030a920b5bSAndy Whitcroft 4040a920b5bSAndy Whitcroftsub top_of_kernel_tree { 4056c72ffaaSAndy Whitcroft my ($root) = @_; 4066c72ffaaSAndy Whitcroft 4076c72ffaaSAndy Whitcroft my @tree_check = ( 4086c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 4096c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 4106c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 4116c72ffaaSAndy Whitcroft ); 4126c72ffaaSAndy Whitcroft 4136c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 4146c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 4150a920b5bSAndy Whitcroft return 0; 4160a920b5bSAndy Whitcroft } 4176c72ffaaSAndy Whitcroft } 4186c72ffaaSAndy Whitcroft return 1; 4196c72ffaaSAndy Whitcroft } 4200a920b5bSAndy Whitcroft 42120112475SJoe Perchessub parse_email { 42220112475SJoe Perches my ($formatted_email) = @_; 42320112475SJoe Perches 42420112475SJoe Perches my $name = ""; 42520112475SJoe Perches my $address = ""; 42620112475SJoe Perches my $comment = ""; 42720112475SJoe Perches 42820112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 42920112475SJoe Perches $name = $1; 43020112475SJoe Perches $address = $2; 43120112475SJoe Perches $comment = $3 if defined $3; 43220112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 43320112475SJoe Perches $address = $1; 43420112475SJoe Perches $comment = $2 if defined $2; 43520112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 43620112475SJoe Perches $address = $1; 43720112475SJoe Perches $comment = $2 if defined $2; 43820112475SJoe Perches $formatted_email =~ s/$address.*$//; 43920112475SJoe Perches $name = $formatted_email; 44020112475SJoe Perches $name =~ s/^\s+|\s+$//g; 44120112475SJoe Perches $name =~ s/^\"|\"$//g; 44220112475SJoe Perches # If there's a name left after stripping spaces and 44320112475SJoe Perches # leading quotes, and the address doesn't have both 44420112475SJoe Perches # leading and trailing angle brackets, the address 44520112475SJoe Perches # is invalid. ie: 44620112475SJoe Perches # "joe smith [email protected]" bad 44720112475SJoe Perches # "joe smith <[email protected]" bad 44820112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 44920112475SJoe Perches $name = ""; 45020112475SJoe Perches $address = ""; 45120112475SJoe Perches $comment = ""; 45220112475SJoe Perches } 45320112475SJoe Perches } 45420112475SJoe Perches 45520112475SJoe Perches $name =~ s/^\s+|\s+$//g; 45620112475SJoe Perches $name =~ s/^\"|\"$//g; 45720112475SJoe Perches $address =~ s/^\s+|\s+$//g; 45820112475SJoe Perches $address =~ s/^\<|\>$//g; 45920112475SJoe Perches 46020112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 46120112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 46220112475SJoe Perches $name = "\"$name\""; 46320112475SJoe Perches } 46420112475SJoe Perches 46520112475SJoe Perches return ($name, $address, $comment); 46620112475SJoe Perches} 46720112475SJoe Perches 46820112475SJoe Perchessub format_email { 46920112475SJoe Perches my ($name, $address) = @_; 47020112475SJoe Perches 47120112475SJoe Perches my $formatted_email; 47220112475SJoe Perches 47320112475SJoe Perches $name =~ s/^\s+|\s+$//g; 47420112475SJoe Perches $name =~ s/^\"|\"$//g; 47520112475SJoe Perches $address =~ s/^\s+|\s+$//g; 47620112475SJoe Perches 47720112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 47820112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 47920112475SJoe Perches $name = "\"$name\""; 48020112475SJoe Perches } 48120112475SJoe Perches 48220112475SJoe Perches if ("$name" eq "") { 48320112475SJoe Perches $formatted_email = "$address"; 48420112475SJoe Perches } else { 48520112475SJoe Perches $formatted_email = "$name <$address>"; 48620112475SJoe Perches } 48720112475SJoe Perches 48820112475SJoe Perches return $formatted_email; 48920112475SJoe Perches} 49020112475SJoe Perches 491000d1cc1SJoe Perchessub which_conf { 492000d1cc1SJoe Perches my ($conf) = @_; 493000d1cc1SJoe Perches 494000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 495000d1cc1SJoe Perches if (-e "$path/$conf") { 496000d1cc1SJoe Perches return "$path/$conf"; 497000d1cc1SJoe Perches } 498000d1cc1SJoe Perches } 499000d1cc1SJoe Perches 500000d1cc1SJoe Perches return ""; 501000d1cc1SJoe Perches} 502000d1cc1SJoe Perches 5030a920b5bSAndy Whitcroftsub expand_tabs { 5040a920b5bSAndy Whitcroft my ($str) = @_; 5050a920b5bSAndy Whitcroft 5060a920b5bSAndy Whitcroft my $res = ''; 5070a920b5bSAndy Whitcroft my $n = 0; 5080a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 5090a920b5bSAndy Whitcroft if ($c eq "\t") { 5100a920b5bSAndy Whitcroft $res .= ' '; 5110a920b5bSAndy Whitcroft $n++; 5120a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 5130a920b5bSAndy Whitcroft $res .= ' '; 5140a920b5bSAndy Whitcroft } 5150a920b5bSAndy Whitcroft next; 5160a920b5bSAndy Whitcroft } 5170a920b5bSAndy Whitcroft $res .= $c; 5180a920b5bSAndy Whitcroft $n++; 5190a920b5bSAndy Whitcroft } 5200a920b5bSAndy Whitcroft 5210a920b5bSAndy Whitcroft return $res; 5220a920b5bSAndy Whitcroft} 5236c72ffaaSAndy Whitcroftsub copy_spacing { 524773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 5256c72ffaaSAndy Whitcroft return $res; 5266c72ffaaSAndy Whitcroft} 5270a920b5bSAndy Whitcroft 5284a0df2efSAndy Whitcroftsub line_stats { 5294a0df2efSAndy Whitcroft my ($line) = @_; 5304a0df2efSAndy Whitcroft 5314a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 5324a0df2efSAndy Whitcroft $line =~ s/^.//; 5334a0df2efSAndy Whitcroft $line = expand_tabs($line); 5344a0df2efSAndy Whitcroft 5354a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 5364a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 5374a0df2efSAndy Whitcroft 5384a0df2efSAndy Whitcroft return (length($line), length($white)); 5394a0df2efSAndy Whitcroft} 5404a0df2efSAndy Whitcroft 541773647a0SAndy Whitcroftmy $sanitise_quote = ''; 542773647a0SAndy Whitcroft 543773647a0SAndy Whitcroftsub sanitise_line_reset { 544773647a0SAndy Whitcroft my ($in_comment) = @_; 545773647a0SAndy Whitcroft 546773647a0SAndy Whitcroft if ($in_comment) { 547773647a0SAndy Whitcroft $sanitise_quote = '*/'; 548773647a0SAndy Whitcroft } else { 549773647a0SAndy Whitcroft $sanitise_quote = ''; 550773647a0SAndy Whitcroft } 551773647a0SAndy Whitcroft} 55200df344fSAndy Whitcroftsub sanitise_line { 55300df344fSAndy Whitcroft my ($line) = @_; 55400df344fSAndy Whitcroft 55500df344fSAndy Whitcroft my $res = ''; 55600df344fSAndy Whitcroft my $l = ''; 55700df344fSAndy Whitcroft 558c2fdda0dSAndy Whitcroft my $qlen = 0; 559773647a0SAndy Whitcroft my $off = 0; 560773647a0SAndy Whitcroft my $c; 56100df344fSAndy Whitcroft 562773647a0SAndy Whitcroft # Always copy over the diff marker. 563773647a0SAndy Whitcroft $res = substr($line, 0, 1); 564773647a0SAndy Whitcroft 565773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 566773647a0SAndy Whitcroft $c = substr($line, $off, 1); 567773647a0SAndy Whitcroft 568773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 569773647a0SAndy Whitcroft # and end, all to $;. 570773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 571773647a0SAndy Whitcroft $sanitise_quote = '*/'; 572773647a0SAndy Whitcroft 573773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 574773647a0SAndy Whitcroft $off++; 57500df344fSAndy Whitcroft next; 576773647a0SAndy Whitcroft } 57781bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 578773647a0SAndy Whitcroft $sanitise_quote = ''; 579773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 580773647a0SAndy Whitcroft $off++; 581773647a0SAndy Whitcroft next; 582773647a0SAndy Whitcroft } 583113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 584113f04a8SDaniel Walker $sanitise_quote = '//'; 585113f04a8SDaniel Walker 586113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 587113f04a8SDaniel Walker $off++; 588113f04a8SDaniel Walker next; 589113f04a8SDaniel Walker } 590773647a0SAndy Whitcroft 591773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 592773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 593773647a0SAndy Whitcroft $c eq "\\") { 594773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 595773647a0SAndy Whitcroft $off++; 596773647a0SAndy Whitcroft next; 597773647a0SAndy Whitcroft } 598773647a0SAndy Whitcroft # Regular quotes. 599773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 600773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 601773647a0SAndy Whitcroft $sanitise_quote = $c; 602773647a0SAndy Whitcroft 603773647a0SAndy Whitcroft substr($res, $off, 1, $c); 604773647a0SAndy Whitcroft next; 605773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 606773647a0SAndy Whitcroft $sanitise_quote = ''; 60700df344fSAndy Whitcroft } 60800df344fSAndy Whitcroft } 609773647a0SAndy Whitcroft 610fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 611773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 612773647a0SAndy Whitcroft substr($res, $off, 1, $;); 613113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 614113f04a8SDaniel Walker substr($res, $off, 1, $;); 615773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 616773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 61700df344fSAndy Whitcroft } else { 618773647a0SAndy Whitcroft substr($res, $off, 1, $c); 61900df344fSAndy Whitcroft } 620c2fdda0dSAndy Whitcroft } 621c2fdda0dSAndy Whitcroft 622113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 623113f04a8SDaniel Walker $sanitise_quote = ''; 624113f04a8SDaniel Walker } 625113f04a8SDaniel Walker 626c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 627c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 628c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 629c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 630c2fdda0dSAndy Whitcroft 631c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 632c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 633c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 634c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 635c2fdda0dSAndy Whitcroft } 636c2fdda0dSAndy Whitcroft 63700df344fSAndy Whitcroft return $res; 63800df344fSAndy Whitcroft} 63900df344fSAndy Whitcroft 6408905a67cSAndy Whitcroftsub ctx_statement_block { 6418905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 6428905a67cSAndy Whitcroft my $line = $linenr - 1; 6438905a67cSAndy Whitcroft my $blk = ''; 6448905a67cSAndy Whitcroft my $soff = $off; 6458905a67cSAndy Whitcroft my $coff = $off - 1; 646773647a0SAndy Whitcroft my $coff_set = 0; 6478905a67cSAndy Whitcroft 64813214adfSAndy Whitcroft my $loff = 0; 64913214adfSAndy Whitcroft 6508905a67cSAndy Whitcroft my $type = ''; 6518905a67cSAndy Whitcroft my $level = 0; 652a2750645SAndy Whitcroft my @stack = (); 653cf655043SAndy Whitcroft my $p; 6548905a67cSAndy Whitcroft my $c; 6558905a67cSAndy Whitcroft my $len = 0; 65613214adfSAndy Whitcroft 65713214adfSAndy Whitcroft my $remainder; 6588905a67cSAndy Whitcroft while (1) { 659a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 660a2750645SAndy Whitcroft 661773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 6628905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 6638905a67cSAndy Whitcroft # context. 6648905a67cSAndy Whitcroft if ($off >= $len) { 6658905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 666dea33496SAndy Whitcroft last if (!defined $lines[$line]); 667c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 6688905a67cSAndy Whitcroft $remain--; 66913214adfSAndy Whitcroft $loff = $len; 670c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 6718905a67cSAndy Whitcroft $len = length($blk); 6728905a67cSAndy Whitcroft $line++; 6738905a67cSAndy Whitcroft last; 6748905a67cSAndy Whitcroft } 6758905a67cSAndy Whitcroft # Bail if there is no further context. 6768905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 67713214adfSAndy Whitcroft if ($off >= $len) { 6788905a67cSAndy Whitcroft last; 6798905a67cSAndy Whitcroft } 680f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 681f74bd194SAndy Whitcroft $level++; 682f74bd194SAndy Whitcroft $type = '#'; 683f74bd194SAndy Whitcroft } 6848905a67cSAndy Whitcroft } 685cf655043SAndy Whitcroft $p = $c; 6868905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 68713214adfSAndy Whitcroft $remainder = substr($blk, $off); 6888905a67cSAndy Whitcroft 689773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 6904635f4fbSAndy Whitcroft 6914635f4fbSAndy Whitcroft # Handle nested #if/#else. 6924635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 6934635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 6944635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 6954635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 6964635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 6974635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 6984635f4fbSAndy Whitcroft } 6994635f4fbSAndy Whitcroft 7008905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 7018905a67cSAndy Whitcroft # outermost level. 7028905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 7038905a67cSAndy Whitcroft last; 7048905a67cSAndy Whitcroft } 7058905a67cSAndy Whitcroft 70613214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 707773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 708773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 709773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 710773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 711773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 712773647a0SAndy Whitcroft $coff_set = 1; 713773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 714773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 71513214adfSAndy Whitcroft } 71613214adfSAndy Whitcroft 7178905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 7188905a67cSAndy Whitcroft $level++; 7198905a67cSAndy Whitcroft $type = '('; 7208905a67cSAndy Whitcroft } 7218905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 7228905a67cSAndy Whitcroft $level--; 7238905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 7248905a67cSAndy Whitcroft 7258905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 7268905a67cSAndy Whitcroft $coff = $off; 727773647a0SAndy Whitcroft $coff_set = 1; 728773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 7298905a67cSAndy Whitcroft } 7308905a67cSAndy Whitcroft } 7318905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 7328905a67cSAndy Whitcroft $level++; 7338905a67cSAndy Whitcroft $type = '{'; 7348905a67cSAndy Whitcroft } 7358905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 7368905a67cSAndy Whitcroft $level--; 7378905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 7388905a67cSAndy Whitcroft 7398905a67cSAndy Whitcroft if ($level == 0) { 740b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 741b998e001SPatrick Pannuto $off++; 742b998e001SPatrick Pannuto } 7438905a67cSAndy Whitcroft last; 7448905a67cSAndy Whitcroft } 7458905a67cSAndy Whitcroft } 746f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 747f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 748f74bd194SAndy Whitcroft $level--; 749f74bd194SAndy Whitcroft $type = ''; 750f74bd194SAndy Whitcroft $off++; 751f74bd194SAndy Whitcroft last; 752f74bd194SAndy Whitcroft } 7538905a67cSAndy Whitcroft $off++; 7548905a67cSAndy Whitcroft } 755a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 75613214adfSAndy Whitcroft if ($off == $len) { 757a3bb97a7SAndy Whitcroft $loff = $len + 1; 75813214adfSAndy Whitcroft $line++; 75913214adfSAndy Whitcroft $remain--; 76013214adfSAndy Whitcroft } 7618905a67cSAndy Whitcroft 7628905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 7638905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 7648905a67cSAndy Whitcroft 7658905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 7668905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 7678905a67cSAndy Whitcroft 768773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 76913214adfSAndy Whitcroft 77013214adfSAndy Whitcroft return ($statement, $condition, 77113214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 77213214adfSAndy Whitcroft} 77313214adfSAndy Whitcroft 774cf655043SAndy Whitcroftsub statement_lines { 775cf655043SAndy Whitcroft my ($stmt) = @_; 776cf655043SAndy Whitcroft 777cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 778cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 779cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 780cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 781cf655043SAndy Whitcroft 782cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 783cf655043SAndy Whitcroft 784cf655043SAndy Whitcroft return $#stmt_lines + 2; 785cf655043SAndy Whitcroft} 786cf655043SAndy Whitcroft 787cf655043SAndy Whitcroftsub statement_rawlines { 788cf655043SAndy Whitcroft my ($stmt) = @_; 789cf655043SAndy Whitcroft 790cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 791cf655043SAndy Whitcroft 792cf655043SAndy Whitcroft return $#stmt_lines + 2; 793cf655043SAndy Whitcroft} 794cf655043SAndy Whitcroft 795cf655043SAndy Whitcroftsub statement_block_size { 796cf655043SAndy Whitcroft my ($stmt) = @_; 797cf655043SAndy Whitcroft 798cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 799cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 800cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 801cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 802cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 803cf655043SAndy Whitcroft 804cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 805cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 806cf655043SAndy Whitcroft 807cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 808cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 809cf655043SAndy Whitcroft 810cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 811cf655043SAndy Whitcroft return $stmt_lines; 812cf655043SAndy Whitcroft } else { 813cf655043SAndy Whitcroft return $stmt_statements; 814cf655043SAndy Whitcroft } 815cf655043SAndy Whitcroft} 816cf655043SAndy Whitcroft 81713214adfSAndy Whitcroftsub ctx_statement_full { 81813214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 81913214adfSAndy Whitcroft my ($statement, $condition, $level); 82013214adfSAndy Whitcroft 82113214adfSAndy Whitcroft my (@chunks); 82213214adfSAndy Whitcroft 823cf655043SAndy Whitcroft # Grab the first conditional/block pair. 82413214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 82513214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 826773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 82713214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 828cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 829cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 830cf655043SAndy Whitcroft } 831cf655043SAndy Whitcroft 832cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 833cf655043SAndy Whitcroft # could continue the statement. 834cf655043SAndy Whitcroft for (;;) { 83513214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 83613214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 837cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 838773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 839cf655043SAndy Whitcroft #print "C: push\n"; 840cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 84113214adfSAndy Whitcroft } 84213214adfSAndy Whitcroft 84313214adfSAndy Whitcroft return ($level, $linenr, @chunks); 8448905a67cSAndy Whitcroft} 8458905a67cSAndy Whitcroft 8464a0df2efSAndy Whitcroftsub ctx_block_get { 847f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 8484a0df2efSAndy Whitcroft my $line; 8494a0df2efSAndy Whitcroft my $start = $linenr - 1; 8504a0df2efSAndy Whitcroft my $blk = ''; 8514a0df2efSAndy Whitcroft my @o; 8524a0df2efSAndy Whitcroft my @c; 8534a0df2efSAndy Whitcroft my @res = (); 8544a0df2efSAndy Whitcroft 855f0a594c1SAndy Whitcroft my $level = 0; 8564635f4fbSAndy Whitcroft my @stack = ($level); 85700df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 85800df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 85900df344fSAndy Whitcroft $remain--; 86000df344fSAndy Whitcroft 86100df344fSAndy Whitcroft $blk .= $rawlines[$line]; 8624635f4fbSAndy Whitcroft 8634635f4fbSAndy Whitcroft # Handle nested #if/#else. 86401464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 8654635f4fbSAndy Whitcroft push(@stack, $level); 86601464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 8674635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 86801464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 8694635f4fbSAndy Whitcroft $level = pop(@stack); 8704635f4fbSAndy Whitcroft } 8714635f4fbSAndy Whitcroft 87201464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 873f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 874f0a594c1SAndy Whitcroft if ($off > 0) { 875f0a594c1SAndy Whitcroft $off--; 876f0a594c1SAndy Whitcroft next; 877f0a594c1SAndy Whitcroft } 8784a0df2efSAndy Whitcroft 879f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 880f0a594c1SAndy Whitcroft $level--; 881f0a594c1SAndy Whitcroft last if ($level == 0); 882f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 883f0a594c1SAndy Whitcroft $level++; 884f0a594c1SAndy Whitcroft } 885f0a594c1SAndy Whitcroft } 8864a0df2efSAndy Whitcroft 887f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 88800df344fSAndy Whitcroft push(@res, $rawlines[$line]); 8894a0df2efSAndy Whitcroft } 8904a0df2efSAndy Whitcroft 891f0a594c1SAndy Whitcroft last if ($level == 0); 8924a0df2efSAndy Whitcroft } 8934a0df2efSAndy Whitcroft 894f0a594c1SAndy Whitcroft return ($level, @res); 8954a0df2efSAndy Whitcroft} 8964a0df2efSAndy Whitcroftsub ctx_block_outer { 8974a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 8984a0df2efSAndy Whitcroft 899f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 900f0a594c1SAndy Whitcroft return @r; 9014a0df2efSAndy Whitcroft} 9024a0df2efSAndy Whitcroftsub ctx_block { 9034a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 9044a0df2efSAndy Whitcroft 905f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 906f0a594c1SAndy Whitcroft return @r; 907653d4876SAndy Whitcroft} 908653d4876SAndy Whitcroftsub ctx_statement { 909f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 910f0a594c1SAndy Whitcroft 911f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 912f0a594c1SAndy Whitcroft return @r; 913f0a594c1SAndy Whitcroft} 914f0a594c1SAndy Whitcroftsub ctx_block_level { 915653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 916653d4876SAndy Whitcroft 917f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 9184a0df2efSAndy Whitcroft} 9199c0ca6f9SAndy Whitcroftsub ctx_statement_level { 9209c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 9219c0ca6f9SAndy Whitcroft 9229c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 9239c0ca6f9SAndy Whitcroft} 9244a0df2efSAndy Whitcroft 9254a0df2efSAndy Whitcroftsub ctx_locate_comment { 9264a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 9274a0df2efSAndy Whitcroft 9284a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 929beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 9304a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 9314a0df2efSAndy Whitcroft 9324a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 9334a0df2efSAndy Whitcroft # comment. 9344a0df2efSAndy Whitcroft my $in_comment = 0; 9354a0df2efSAndy Whitcroft $current_comment = ''; 9364a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 93700df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 93800df344fSAndy Whitcroft #warn " $line\n"; 9394a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 9404a0df2efSAndy Whitcroft $in_comment = 1; 9414a0df2efSAndy Whitcroft } 9424a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 9434a0df2efSAndy Whitcroft $in_comment = 1; 9444a0df2efSAndy Whitcroft } 9454a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 9464a0df2efSAndy Whitcroft $current_comment = ''; 9474a0df2efSAndy Whitcroft } 9484a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 9494a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 9504a0df2efSAndy Whitcroft $in_comment = 0; 9514a0df2efSAndy Whitcroft } 9524a0df2efSAndy Whitcroft } 9534a0df2efSAndy Whitcroft 9544a0df2efSAndy Whitcroft chomp($current_comment); 9554a0df2efSAndy Whitcroft return($current_comment); 9564a0df2efSAndy Whitcroft} 9574a0df2efSAndy Whitcroftsub ctx_has_comment { 9584a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 9594a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 9604a0df2efSAndy Whitcroft 96100df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 9624a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 9634a0df2efSAndy Whitcroft 9644a0df2efSAndy Whitcroft return ($cmt ne ''); 9654a0df2efSAndy Whitcroft} 9664a0df2efSAndy Whitcroft 9674d001e4dSAndy Whitcroftsub raw_line { 9684d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 9694d001e4dSAndy Whitcroft 9704d001e4dSAndy Whitcroft my $offset = $linenr - 1; 9714d001e4dSAndy Whitcroft $cnt++; 9724d001e4dSAndy Whitcroft 9734d001e4dSAndy Whitcroft my $line; 9744d001e4dSAndy Whitcroft while ($cnt) { 9754d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 9764d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 9774d001e4dSAndy Whitcroft $cnt--; 9784d001e4dSAndy Whitcroft } 9794d001e4dSAndy Whitcroft 9804d001e4dSAndy Whitcroft return $line; 9814d001e4dSAndy Whitcroft} 9824d001e4dSAndy Whitcroft 9830a920b5bSAndy Whitcroftsub cat_vet { 9840a920b5bSAndy Whitcroft my ($vet) = @_; 9859c0ca6f9SAndy Whitcroft my ($res, $coded); 9860a920b5bSAndy Whitcroft 9879c0ca6f9SAndy Whitcroft $res = ''; 9886c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 9896c72ffaaSAndy Whitcroft $res .= $1; 9906c72ffaaSAndy Whitcroft if ($2 ne '') { 9919c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 9926c72ffaaSAndy Whitcroft $res .= $coded; 9936c72ffaaSAndy Whitcroft } 9949c0ca6f9SAndy Whitcroft } 9959c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 9960a920b5bSAndy Whitcroft 9979c0ca6f9SAndy Whitcroft return $res; 9980a920b5bSAndy Whitcroft} 9990a920b5bSAndy Whitcroft 1000c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1001cf655043SAndy Whitcroftmy $av_pending; 1002c2fdda0dSAndy Whitcroftmy @av_paren_type; 10031f65f947SAndy Whitcroftmy $av_pend_colon; 1004c2fdda0dSAndy Whitcroft 1005c2fdda0dSAndy Whitcroftsub annotate_reset { 1006c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1007cf655043SAndy Whitcroft $av_pending = '_'; 1008cf655043SAndy Whitcroft @av_paren_type = ('E'); 10091f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1010c2fdda0dSAndy Whitcroft} 1011c2fdda0dSAndy Whitcroft 10126c72ffaaSAndy Whitcroftsub annotate_values { 10136c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 10146c72ffaaSAndy Whitcroft 10156c72ffaaSAndy Whitcroft my $res; 10161f65f947SAndy Whitcroft my $var = '_' x length($stream); 10176c72ffaaSAndy Whitcroft my $cur = $stream; 10186c72ffaaSAndy Whitcroft 1019c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 10206c72ffaaSAndy Whitcroft 10216c72ffaaSAndy Whitcroft while (length($cur)) { 1022773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1023cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1024171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 10256c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1026c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1027c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1028cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1029c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 10306c72ffaaSAndy Whitcroft } 10316c72ffaaSAndy Whitcroft 1032c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 10339446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 10349446ef56SAndy Whitcroft push(@av_paren_type, $type); 10359446ef56SAndy Whitcroft $type = 'C'; 10369446ef56SAndy Whitcroft 1037e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1038c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 10396c72ffaaSAndy Whitcroft $type = 'T'; 10406c72ffaaSAndy Whitcroft 1041389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1042389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1043389a2fe5SAndy Whitcroft $type = 'T'; 1044389a2fe5SAndy Whitcroft 1045c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1046171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1047c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1048171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1049171ae1a4SAndy Whitcroft if ($2 ne '') { 1050cf655043SAndy Whitcroft $av_pending = 'N'; 1051171ae1a4SAndy Whitcroft } 1052171ae1a4SAndy Whitcroft $type = 'E'; 1053171ae1a4SAndy Whitcroft 1054c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1055171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1056171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1057171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 10586c72ffaaSAndy Whitcroft 1059c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1060cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1061c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1062cf655043SAndy Whitcroft 1063cf655043SAndy Whitcroft push(@av_paren_type, $type); 1064cf655043SAndy Whitcroft push(@av_paren_type, $type); 1065171ae1a4SAndy Whitcroft $type = 'E'; 1066cf655043SAndy Whitcroft 1067c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1068cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1069cf655043SAndy Whitcroft $av_preprocessor = 1; 1070cf655043SAndy Whitcroft 1071cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1072cf655043SAndy Whitcroft 1073171ae1a4SAndy Whitcroft $type = 'E'; 1074cf655043SAndy Whitcroft 1075c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1076cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1077cf655043SAndy Whitcroft 1078cf655043SAndy Whitcroft $av_preprocessor = 1; 1079cf655043SAndy Whitcroft 1080cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1081cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1082cf655043SAndy Whitcroft pop(@av_paren_type); 1083cf655043SAndy Whitcroft push(@av_paren_type, $type); 1084171ae1a4SAndy Whitcroft $type = 'E'; 10856c72ffaaSAndy Whitcroft 10866c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1087c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 10886c72ffaaSAndy Whitcroft 1089171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1090171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1091171ae1a4SAndy Whitcroft $av_pending = $type; 1092171ae1a4SAndy Whitcroft $type = 'N'; 1093171ae1a4SAndy Whitcroft 10946c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1095c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 10966c72ffaaSAndy Whitcroft if (defined $2) { 1097cf655043SAndy Whitcroft $av_pending = 'V'; 10986c72ffaaSAndy Whitcroft } 10996c72ffaaSAndy Whitcroft $type = 'N'; 11006c72ffaaSAndy Whitcroft 110114b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1102c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 110314b111c1SAndy Whitcroft $av_pending = 'E'; 11046c72ffaaSAndy Whitcroft $type = 'N'; 11056c72ffaaSAndy Whitcroft 11061f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 11071f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 11081f65f947SAndy Whitcroft $av_pend_colon = 'C'; 11091f65f947SAndy Whitcroft $type = 'N'; 11101f65f947SAndy Whitcroft 111114b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1112c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 11136c72ffaaSAndy Whitcroft $type = 'N'; 11146c72ffaaSAndy Whitcroft 11156c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1116c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1117cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1118cf655043SAndy Whitcroft $av_pending = '_'; 11196c72ffaaSAndy Whitcroft $type = 'N'; 11206c72ffaaSAndy Whitcroft 11216c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1122cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1123cf655043SAndy Whitcroft if ($new_type ne '_') { 1124cf655043SAndy Whitcroft $type = $new_type; 1125c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1126c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 11276c72ffaaSAndy Whitcroft } else { 1128c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 11296c72ffaaSAndy Whitcroft } 11306c72ffaaSAndy Whitcroft 1131c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1132c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1133c8cb2ca3SAndy Whitcroft $type = 'V'; 1134cf655043SAndy Whitcroft $av_pending = 'V'; 11356c72ffaaSAndy Whitcroft 11368e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 11378e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 11381f65f947SAndy Whitcroft $av_pend_colon = 'B'; 11398e761b04SAndy Whitcroft } elsif ($type eq 'E') { 11408e761b04SAndy Whitcroft $av_pend_colon = 'L'; 11411f65f947SAndy Whitcroft } 11421f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 11431f65f947SAndy Whitcroft $type = 'V'; 11441f65f947SAndy Whitcroft 11456c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1146c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 11476c72ffaaSAndy Whitcroft $type = 'V'; 11486c72ffaaSAndy Whitcroft 11496c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1150c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 11516c72ffaaSAndy Whitcroft $type = 'N'; 11526c72ffaaSAndy Whitcroft 1153cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1154c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 115513214adfSAndy Whitcroft $type = 'E'; 11561f65f947SAndy Whitcroft $av_pend_colon = 'O'; 115713214adfSAndy Whitcroft 11588e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 11598e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 11608e761b04SAndy Whitcroft $type = 'C'; 11618e761b04SAndy Whitcroft 11621f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 11631f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 11641f65f947SAndy Whitcroft $type = 'N'; 11651f65f947SAndy Whitcroft 11661f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 11671f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 11681f65f947SAndy Whitcroft 11691f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 11701f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 11711f65f947SAndy Whitcroft $type = 'E'; 11721f65f947SAndy Whitcroft } else { 11731f65f947SAndy Whitcroft $type = 'N'; 11741f65f947SAndy Whitcroft } 11751f65f947SAndy Whitcroft $av_pend_colon = 'O'; 11761f65f947SAndy Whitcroft 11778e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 117813214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 11796c72ffaaSAndy Whitcroft $type = 'N'; 11806c72ffaaSAndy Whitcroft 11810d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 118274048ed8SAndy Whitcroft my $variant; 118374048ed8SAndy Whitcroft 118474048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 118574048ed8SAndy Whitcroft if ($type eq 'V') { 118674048ed8SAndy Whitcroft $variant = 'B'; 118774048ed8SAndy Whitcroft } else { 118874048ed8SAndy Whitcroft $variant = 'U'; 118974048ed8SAndy Whitcroft } 119074048ed8SAndy Whitcroft 119174048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 119274048ed8SAndy Whitcroft $type = 'N'; 119374048ed8SAndy Whitcroft 11946c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1195c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 11966c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 11976c72ffaaSAndy Whitcroft $type = 'N'; 11986c72ffaaSAndy Whitcroft } 11996c72ffaaSAndy Whitcroft 12006c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1201c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 12026c72ffaaSAndy Whitcroft } 12036c72ffaaSAndy Whitcroft if (defined $1) { 12046c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 12056c72ffaaSAndy Whitcroft $res .= $type x length($1); 12066c72ffaaSAndy Whitcroft } 12076c72ffaaSAndy Whitcroft } 12086c72ffaaSAndy Whitcroft 12091f65f947SAndy Whitcroft return ($res, $var); 12106c72ffaaSAndy Whitcroft} 12116c72ffaaSAndy Whitcroft 12128905a67cSAndy Whitcroftsub possible { 121313214adfSAndy Whitcroft my ($possible, $line) = @_; 12149a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 12150776e594SAndy Whitcroft ^(?: 12160776e594SAndy Whitcroft $Modifier| 12170776e594SAndy Whitcroft $Storage| 12180776e594SAndy Whitcroft $Type| 12199a974fdbSAndy Whitcroft DEFINE_\S+ 12209a974fdbSAndy Whitcroft )$| 12219a974fdbSAndy Whitcroft ^(?: 12220776e594SAndy Whitcroft goto| 12230776e594SAndy Whitcroft return| 12240776e594SAndy Whitcroft case| 12250776e594SAndy Whitcroft else| 12260776e594SAndy Whitcroft asm|__asm__| 122789a88353SAndy Whitcroft do| 122889a88353SAndy Whitcroft \#| 122989a88353SAndy Whitcroft \#\#| 12309a974fdbSAndy Whitcroft )(?:\s|$)| 12310776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 12329a974fdbSAndy Whitcroft )}x; 12339a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 12349a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1235c45dcabdSAndy Whitcroft # Check for modifiers. 1236c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1237c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1238c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1239c45dcabdSAndy Whitcroft 1240c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1241c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1242d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 12439a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1244d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1245d2506586SAndy Whitcroft push(@modifierList, $modifier); 1246d2506586SAndy Whitcroft } 12479a974fdbSAndy Whitcroft } 1248c45dcabdSAndy Whitcroft 1249c45dcabdSAndy Whitcroft } else { 125013214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 12518905a67cSAndy Whitcroft push(@typeList, $possible); 1252c45dcabdSAndy Whitcroft } 12538905a67cSAndy Whitcroft build_types(); 12540776e594SAndy Whitcroft } else { 12550776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 12568905a67cSAndy Whitcroft } 12578905a67cSAndy Whitcroft} 12588905a67cSAndy Whitcroft 12596c72ffaaSAndy Whitcroftmy $prefix = ''; 12606c72ffaaSAndy Whitcroft 1261000d1cc1SJoe Perchessub show_type { 1262000d1cc1SJoe Perches return !defined $ignore_type{$_[0]}; 1263000d1cc1SJoe Perches} 1264000d1cc1SJoe Perches 1265f0a594c1SAndy Whitcroftsub report { 1266000d1cc1SJoe Perches if (!show_type($_[1]) || 1267000d1cc1SJoe Perches (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) { 1268773647a0SAndy Whitcroft return 0; 1269773647a0SAndy Whitcroft } 1270000d1cc1SJoe Perches my $line; 1271000d1cc1SJoe Perches if ($show_types) { 1272000d1cc1SJoe Perches $line = "$prefix$_[0]:$_[1]: $_[2]\n"; 1273000d1cc1SJoe Perches } else { 1274000d1cc1SJoe Perches $line = "$prefix$_[0]: $_[2]\n"; 1275000d1cc1SJoe Perches } 12768905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 12778905a67cSAndy Whitcroft 127813214adfSAndy Whitcroft push(our @report, $line); 1279773647a0SAndy Whitcroft 1280773647a0SAndy Whitcroft return 1; 1281f0a594c1SAndy Whitcroft} 1282f0a594c1SAndy Whitcroftsub report_dump { 128313214adfSAndy Whitcroft our @report; 1284f0a594c1SAndy Whitcroft} 1285000d1cc1SJoe Perches 1286de7d4f0eSAndy Whitcroftsub ERROR { 1287000d1cc1SJoe Perches if (report("ERROR", $_[0], $_[1])) { 1288de7d4f0eSAndy Whitcroft our $clean = 0; 12896c72ffaaSAndy Whitcroft our $cnt_error++; 1290de7d4f0eSAndy Whitcroft } 1291773647a0SAndy Whitcroft} 1292de7d4f0eSAndy Whitcroftsub WARN { 1293000d1cc1SJoe Perches if (report("WARNING", $_[0], $_[1])) { 1294de7d4f0eSAndy Whitcroft our $clean = 0; 12956c72ffaaSAndy Whitcroft our $cnt_warn++; 1296de7d4f0eSAndy Whitcroft } 1297773647a0SAndy Whitcroft} 1298de7d4f0eSAndy Whitcroftsub CHK { 1299000d1cc1SJoe Perches if ($check && report("CHECK", $_[0], $_[1])) { 1300de7d4f0eSAndy Whitcroft our $clean = 0; 13016c72ffaaSAndy Whitcroft our $cnt_chk++; 13026c72ffaaSAndy Whitcroft } 1303de7d4f0eSAndy Whitcroft} 1304de7d4f0eSAndy Whitcroft 13056ecd9674SAndy Whitcroftsub check_absolute_file { 13066ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 13076ecd9674SAndy Whitcroft my $file = $absolute; 13086ecd9674SAndy Whitcroft 13096ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 13106ecd9674SAndy Whitcroft 13116ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 13126ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 13136ecd9674SAndy Whitcroft if (-f "$root/$file") { 13146ecd9674SAndy Whitcroft ##print "file<$file>\n"; 13156ecd9674SAndy Whitcroft last; 13166ecd9674SAndy Whitcroft } 13176ecd9674SAndy Whitcroft } 13186ecd9674SAndy Whitcroft if (! -f _) { 13196ecd9674SAndy Whitcroft return 0; 13206ecd9674SAndy Whitcroft } 13216ecd9674SAndy Whitcroft 13226ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 13236ecd9674SAndy Whitcroft my $prefix = $absolute; 13246ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 13256ecd9674SAndy Whitcroft 13266ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 13276ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1328000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1329000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 13306ecd9674SAndy Whitcroft } 13316ecd9674SAndy Whitcroft} 13326ecd9674SAndy Whitcroft 13330a920b5bSAndy Whitcroftsub process { 13340a920b5bSAndy Whitcroft my $filename = shift; 13350a920b5bSAndy Whitcroft 13360a920b5bSAndy Whitcroft my $linenr=0; 13370a920b5bSAndy Whitcroft my $prevline=""; 1338c2fdda0dSAndy Whitcroft my $prevrawline=""; 13390a920b5bSAndy Whitcroft my $stashline=""; 1340c2fdda0dSAndy Whitcroft my $stashrawline=""; 13410a920b5bSAndy Whitcroft 13424a0df2efSAndy Whitcroft my $length; 13430a920b5bSAndy Whitcroft my $indent; 13440a920b5bSAndy Whitcroft my $previndent=0; 13450a920b5bSAndy Whitcroft my $stashindent=0; 13460a920b5bSAndy Whitcroft 1347de7d4f0eSAndy Whitcroft our $clean = 1; 13480a920b5bSAndy Whitcroft my $signoff = 0; 13490a920b5bSAndy Whitcroft my $is_patch = 0; 13500a920b5bSAndy Whitcroft 135115662b3eSJoe Perches my $in_header_lines = 1; 135215662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 135315662b3eSJoe Perches 135413214adfSAndy Whitcroft our @report = (); 13556c72ffaaSAndy Whitcroft our $cnt_lines = 0; 13566c72ffaaSAndy Whitcroft our $cnt_error = 0; 13576c72ffaaSAndy Whitcroft our $cnt_warn = 0; 13586c72ffaaSAndy Whitcroft our $cnt_chk = 0; 13596c72ffaaSAndy Whitcroft 13600a920b5bSAndy Whitcroft # Trace the real file/line as we go. 13610a920b5bSAndy Whitcroft my $realfile = ''; 13620a920b5bSAndy Whitcroft my $realline = 0; 13630a920b5bSAndy Whitcroft my $realcnt = 0; 13640a920b5bSAndy Whitcroft my $here = ''; 13650a920b5bSAndy Whitcroft my $in_comment = 0; 1366c2fdda0dSAndy Whitcroft my $comment_edge = 0; 13670a920b5bSAndy Whitcroft my $first_line = 0; 13681e855726SWolfram Sang my $p1_prefix = ''; 13690a920b5bSAndy Whitcroft 137013214adfSAndy Whitcroft my $prev_values = 'E'; 137113214adfSAndy Whitcroft 137213214adfSAndy Whitcroft # suppression flags 1373773647a0SAndy Whitcroft my %suppress_ifbraces; 1374170d3a22SAndy Whitcroft my %suppress_whiletrailers; 13752b474a1aSAndy Whitcroft my %suppress_export; 1376*3e469cdcSAndy Whitcroft my $suppress_statement = 0; 1377653d4876SAndy Whitcroft 1378c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1379de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1380c2fdda0dSAndy Whitcroft # 1381de7d4f0eSAndy Whitcroft my @setup_docs = (); 1382de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1383773647a0SAndy Whitcroft 1384773647a0SAndy Whitcroft sanitise_line_reset(); 1385c2fdda0dSAndy Whitcroft my $line; 1386c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1387773647a0SAndy Whitcroft $linenr++; 1388773647a0SAndy Whitcroft $line = $rawline; 1389c2fdda0dSAndy Whitcroft 1390773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1391de7d4f0eSAndy Whitcroft $setup_docs = 0; 1392de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1393de7d4f0eSAndy Whitcroft $setup_docs = 1; 1394de7d4f0eSAndy Whitcroft } 1395773647a0SAndy Whitcroft #next; 1396de7d4f0eSAndy Whitcroft } 1397773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1398773647a0SAndy Whitcroft $realline=$1-1; 1399773647a0SAndy Whitcroft if (defined $2) { 1400773647a0SAndy Whitcroft $realcnt=$3+1; 1401773647a0SAndy Whitcroft } else { 1402773647a0SAndy Whitcroft $realcnt=1+1; 1403773647a0SAndy Whitcroft } 1404c45dcabdSAndy Whitcroft $in_comment = 0; 1405773647a0SAndy Whitcroft 1406773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1407773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1408773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1409773647a0SAndy Whitcroft # at context start. 1410773647a0SAndy Whitcroft my $edge; 141101fa9147SAndy Whitcroft my $cnt = $realcnt; 141201fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 141301fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 141401fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 141501fa9147SAndy Whitcroft $cnt--; 141601fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1417721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1418fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1419fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1420fae17daeSAndy Whitcroft ($edge) = $1; 1421fae17daeSAndy Whitcroft last; 1422fae17daeSAndy Whitcroft } 1423773647a0SAndy Whitcroft } 1424773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1425773647a0SAndy Whitcroft $in_comment = 1; 1426773647a0SAndy Whitcroft } 1427773647a0SAndy Whitcroft 1428773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1429773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1430773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1431773647a0SAndy Whitcroft if (!defined $edge && 143283242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1433773647a0SAndy Whitcroft { 1434773647a0SAndy Whitcroft $in_comment = 1; 1435773647a0SAndy Whitcroft } 1436773647a0SAndy Whitcroft 1437773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1438773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1439773647a0SAndy Whitcroft 1440171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1441773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1442171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1443773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1444773647a0SAndy Whitcroft } 1445773647a0SAndy Whitcroft push(@lines, $line); 1446773647a0SAndy Whitcroft 1447773647a0SAndy Whitcroft if ($realcnt > 1) { 1448773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1449773647a0SAndy Whitcroft } else { 1450773647a0SAndy Whitcroft $realcnt = 0; 1451773647a0SAndy Whitcroft } 1452773647a0SAndy Whitcroft 1453773647a0SAndy Whitcroft #print "==>$rawline\n"; 1454773647a0SAndy Whitcroft #print "-->$line\n"; 1455de7d4f0eSAndy Whitcroft 1456de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1457de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1458de7d4f0eSAndy Whitcroft } 1459de7d4f0eSAndy Whitcroft } 1460de7d4f0eSAndy Whitcroft 14616c72ffaaSAndy Whitcroft $prefix = ''; 14626c72ffaaSAndy Whitcroft 1463773647a0SAndy Whitcroft $realcnt = 0; 1464773647a0SAndy Whitcroft $linenr = 0; 14650a920b5bSAndy Whitcroft foreach my $line (@lines) { 14660a920b5bSAndy Whitcroft $linenr++; 14670a920b5bSAndy Whitcroft 1468c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 14696c72ffaaSAndy Whitcroft 14700a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 14716c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 14720a920b5bSAndy Whitcroft $is_patch = 1; 14734a0df2efSAndy Whitcroft $first_line = $linenr + 1; 14740a920b5bSAndy Whitcroft $realline=$1-1; 14750a920b5bSAndy Whitcroft if (defined $2) { 14760a920b5bSAndy Whitcroft $realcnt=$3+1; 14770a920b5bSAndy Whitcroft } else { 14780a920b5bSAndy Whitcroft $realcnt=1+1; 14790a920b5bSAndy Whitcroft } 1480c2fdda0dSAndy Whitcroft annotate_reset(); 148113214adfSAndy Whitcroft $prev_values = 'E'; 148213214adfSAndy Whitcroft 1483773647a0SAndy Whitcroft %suppress_ifbraces = (); 1484170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 14852b474a1aSAndy Whitcroft %suppress_export = (); 1486*3e469cdcSAndy Whitcroft $suppress_statement = 0; 14870a920b5bSAndy Whitcroft next; 14880a920b5bSAndy Whitcroft 14894a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 14904a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 14914a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1492773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 14930a920b5bSAndy Whitcroft $realline++; 1494d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 14950a920b5bSAndy Whitcroft 14964a0df2efSAndy Whitcroft # Measure the line length and indent. 1497c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 14980a920b5bSAndy Whitcroft 14990a920b5bSAndy Whitcroft # Track the previous line. 15000a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 15010a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1502c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1503c2fdda0dSAndy Whitcroft 1504773647a0SAndy Whitcroft #warn "line<$line>\n"; 15056c72ffaaSAndy Whitcroft 1506d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1507d8aaf121SAndy Whitcroft $realcnt--; 15080a920b5bSAndy Whitcroft } 15090a920b5bSAndy Whitcroft 1510cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 1511cc77cdcaSAndy Whitcroft 15120a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1513773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1514773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1515773647a0SAndy Whitcroft 15166c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 15176c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1518773647a0SAndy Whitcroft 1519773647a0SAndy Whitcroft # extract the filename as it passes 15203bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 15213bf9a009SRabin Vincent $realfile = $1; 15223bf9a009SRabin Vincent $realfile =~ s@^([^/]*)/@@; 1523270c49a0SJoe Perches $in_commit_log = 0; 15243bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 1525773647a0SAndy Whitcroft $realfile = $1; 15261e855726SWolfram Sang $realfile =~ s@^([^/]*)/@@; 1527270c49a0SJoe Perches $in_commit_log = 0; 15281e855726SWolfram Sang 15291e855726SWolfram Sang $p1_prefix = $1; 1530e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 1531e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 1532000d1cc1SJoe Perches WARN("PATCH_PREFIX", 1533000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 15341e855726SWolfram Sang } 1535773647a0SAndy Whitcroft 1536c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 1537000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 1538000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1539773647a0SAndy Whitcroft } 1540773647a0SAndy Whitcroft next; 1541773647a0SAndy Whitcroft } 1542773647a0SAndy Whitcroft 1543389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 15440a920b5bSAndy Whitcroft 1545c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1546c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1547c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 15480a920b5bSAndy Whitcroft 15496c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 15506c72ffaaSAndy Whitcroft 15513bf9a009SRabin Vincent# Check for incorrect file permissions 15523bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 15533bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 15543bf9a009SRabin Vincent if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) { 1555000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 1556000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 15573bf9a009SRabin Vincent } 15583bf9a009SRabin Vincent } 15593bf9a009SRabin Vincent 156020112475SJoe Perches# Check the patch for a signoff: 1561d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 15624a0df2efSAndy Whitcroft $signoff++; 156315662b3eSJoe Perches $in_commit_log = 0; 15640a920b5bSAndy Whitcroft } 156520112475SJoe Perches 156620112475SJoe Perches# Check signature styles 1567270c49a0SJoe Perches if (!$in_header_lines && 1568270c49a0SJoe Perches $line =~ /^(\s*)($signature_tags)(\s*)(.*)/) { 156920112475SJoe Perches my $space_before = $1; 157020112475SJoe Perches my $sign_off = $2; 157120112475SJoe Perches my $space_after = $3; 157220112475SJoe Perches my $email = $4; 157320112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 157420112475SJoe Perches 157520112475SJoe Perches if (defined $space_before && $space_before ne "") { 1576000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1577000d1cc1SJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr); 157820112475SJoe Perches } 157920112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 1580000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1581000d1cc1SJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr); 158220112475SJoe Perches } 158320112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 1584000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1585000d1cc1SJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr); 158620112475SJoe Perches } 158720112475SJoe Perches 158820112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 158920112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 159020112475SJoe Perches if ($suggested_email eq "") { 1591000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 1592000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 159320112475SJoe Perches } else { 159420112475SJoe Perches my $dequoted = $suggested_email; 159520112475SJoe Perches $dequoted =~ s/^"//; 159620112475SJoe Perches $dequoted =~ s/" </ </; 159720112475SJoe Perches # Don't force email to have quotes 159820112475SJoe Perches # Allow just an angle bracketed address 159920112475SJoe Perches if ("$dequoted$comment" ne $email && 160020112475SJoe Perches "<$email_address>$comment" ne $email && 160120112475SJoe Perches "$suggested_email$comment" ne $email) { 1602000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1603000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 160420112475SJoe Perches } 16050a920b5bSAndy Whitcroft } 16060a920b5bSAndy Whitcroft } 16070a920b5bSAndy Whitcroft 160800df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 16098905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1610000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 1611000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 16126c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 1613de7d4f0eSAndy Whitcroft } 1614de7d4f0eSAndy Whitcroft 16156ecd9674SAndy Whitcroft# Check for absolute kernel paths. 16166ecd9674SAndy Whitcroft if ($tree) { 16176ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 16186ecd9674SAndy Whitcroft my $file = $1; 16196ecd9674SAndy Whitcroft 16206ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 16216ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 16226ecd9674SAndy Whitcroft # 16236ecd9674SAndy Whitcroft } else { 16246ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 16256ecd9674SAndy Whitcroft } 16266ecd9674SAndy Whitcroft } 16276ecd9674SAndy Whitcroft } 16286ecd9674SAndy Whitcroft 1629de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1630de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 1631171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 1632171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1633171ae1a4SAndy Whitcroft 1634171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 1635171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1636171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 1637171ae1a4SAndy Whitcroft 163834d99219SJoe Perches CHK("INVALID_UTF8", 1639000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 164000df344fSAndy Whitcroft } 16410a920b5bSAndy Whitcroft 164215662b3eSJoe Perches# Check if it's the start of a commit log 164315662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 164415662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 1645270c49a0SJoe Perches $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) { 164615662b3eSJoe Perches $in_header_lines = 0; 164715662b3eSJoe Perches $in_commit_log = 1; 164815662b3eSJoe Perches } 164915662b3eSJoe Perches 165015662b3eSJoe Perches# Still not yet in a patch, check for any UTF-8 165115662b3eSJoe Perches if ($in_commit_log && $realfile =~ /^$/ && 165215662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 165315662b3eSJoe Perches CHK("UTF8_BEFORE_PATCH", 165415662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 165515662b3eSJoe Perches } 165615662b3eSJoe Perches 165730670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 165830670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 165900df344fSAndy Whitcroft 16600a920b5bSAndy Whitcroft#trailing whitespace 16619c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 1662c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1663000d1cc1SJoe Perches ERROR("DOS_LINE_ENDINGS", 1664000d1cc1SJoe Perches "DOS line endings\n" . $herevet); 16659c0ca6f9SAndy Whitcroft 1666c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 1667c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1668000d1cc1SJoe Perches ERROR("TRAILING_WHITESPACE", 1669000d1cc1SJoe Perches "trailing whitespace\n" . $herevet); 1670d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 16710a920b5bSAndy Whitcroft } 16725368df20SAndy Whitcroft 16733354957aSAndi Kleen# check for Kconfig help text having a real description 16749fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 16759fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 16763354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 16779fe287d7SAndy Whitcroft $line =~ /\+\s*(?:---)?help(?:---)?$/) { 16783354957aSAndi Kleen my $length = 0; 16799fe287d7SAndy Whitcroft my $cnt = $realcnt; 16809fe287d7SAndy Whitcroft my $ln = $linenr + 1; 16819fe287d7SAndy Whitcroft my $f; 16829fe287d7SAndy Whitcroft my $is_end = 0; 16839fe287d7SAndy Whitcroft while ($cnt > 0 && defined $lines[$ln - 1]) { 16849fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 16859fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 16869fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 16879fe287d7SAndy Whitcroft $ln++; 16889fe287d7SAndy Whitcroft 16899fe287d7SAndy Whitcroft next if ($f =~ /^-/); 16909fe287d7SAndy Whitcroft $f =~ s/^.//; 16913354957aSAndi Kleen $f =~ s/#.*//; 16923354957aSAndi Kleen $f =~ s/^\s+//; 16933354957aSAndi Kleen next if ($f =~ /^$/); 16949fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 16959fe287d7SAndy Whitcroft $is_end = 1; 16969fe287d7SAndy Whitcroft last; 16979fe287d7SAndy Whitcroft } 16983354957aSAndi Kleen $length++; 16993354957aSAndi Kleen } 1700000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 1701000d1cc1SJoe Perches "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_end && $length < 4); 17029fe287d7SAndy Whitcroft #print "is_end<$is_end> length<$length>\n"; 17033354957aSAndi Kleen } 17043354957aSAndi Kleen 1705c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 1706c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 1707c68e5878SArnaud Lacombe my $flag = $1; 1708c68e5878SArnaud Lacombe my $replacement = { 1709c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 1710c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 1711c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 1712c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 1713c68e5878SArnaud Lacombe }; 1714c68e5878SArnaud Lacombe 1715c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 1716c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 1717c68e5878SArnaud Lacombe } 1718c68e5878SArnaud Lacombe 17195368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 17205368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 17215368df20SAndy Whitcroft 17220a920b5bSAndy Whitcroft#80 column limit 1723c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 1724f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 17250fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 17268bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 1727f4c014c0SAndy Whitcroft $length > 80) 1728c45dcabdSAndy Whitcroft { 1729000d1cc1SJoe Perches WARN("LONG_LINE", 1730000d1cc1SJoe Perches "line over 80 characters\n" . $herecurr); 17310a920b5bSAndy Whitcroft } 17320a920b5bSAndy Whitcroft 17335e79d96eSJoe Perches# check for spaces before a quoted newline 17345e79d96eSJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 1735000d1cc1SJoe Perches WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 1736000d1cc1SJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr); 17375e79d96eSJoe Perches } 17385e79d96eSJoe Perches 17398905a67cSAndy Whitcroft# check for adding lines without a newline. 17408905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 1741000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 1742000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 17438905a67cSAndy Whitcroft } 17448905a67cSAndy Whitcroft 174542e41c54SMike Frysinger# Blackfin: use hi/lo macros 174642e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 174742e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 174842e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1749000d1cc1SJoe Perches ERROR("LO_MACRO", 1750000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 175142e41c54SMike Frysinger } 175242e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 175342e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1754000d1cc1SJoe Perches ERROR("HI_MACRO", 1755000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 175642e41c54SMike Frysinger } 175742e41c54SMike Frysinger } 175842e41c54SMike Frysinger 1759b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 1760b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 17610a920b5bSAndy Whitcroft 17620a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 17630a920b5bSAndy Whitcroft# more than 8 must use tabs. 1764c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 1765c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 1766c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1767000d1cc1SJoe Perches ERROR("CODE_INDENT", 1768000d1cc1SJoe Perches "code indent should use tabs where possible\n" . $herevet); 1769d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 17700a920b5bSAndy Whitcroft } 17710a920b5bSAndy Whitcroft 177208e44365SAlberto Panizzo# check for space before tabs. 177308e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 177408e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1775000d1cc1SJoe Perches WARN("SPACE_BEFORE_TAB", 1776000d1cc1SJoe Perches "please, no space before tabs\n" . $herevet); 177708e44365SAlberto Panizzo } 177808e44365SAlberto Panizzo 17795f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 17806b4c5bebSAndy Whitcroft# Exceptions: 17816b4c5bebSAndy Whitcroft# 1) within comments 17826b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 17836b4c5bebSAndy Whitcroft# 3) hanging labels 17846b4c5bebSAndy Whitcroft if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) { 17855f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1786000d1cc1SJoe Perches WARN("LEADING_SPACE", 1787000d1cc1SJoe Perches "please, no spaces at the start of a line\n" . $herevet); 17885f7ddae6SRaffaele Recalcati } 17895f7ddae6SRaffaele Recalcati 1790b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 1791b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 1792b9ea10d6SAndy Whitcroft 1793c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 1794cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 1795000d1cc1SJoe Perches WARN("CVS_KEYWORD", 1796000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 1797c2fdda0dSAndy Whitcroft } 179822f2a2efSAndy Whitcroft 179942e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 180042e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 180142e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1802000d1cc1SJoe Perches ERROR("CSYNC", 1803000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 180442e41c54SMike Frysinger } 180542e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 180642e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 1807000d1cc1SJoe Perches ERROR("SSYNC", 1808000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 180942e41c54SMike Frysinger } 181042e41c54SMike Frysinger 18119c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 18122b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 18132b474a1aSAndy Whitcroft $realline_next); 1814*3e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 1815*3e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 1816*3e469cdcSAndy Whitcroft $realcnt && $line =~ /.\s*\S/) { 1817170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 1818f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 1819171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 1820171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 1821171ae1a4SAndy Whitcroft 1822*3e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 1823*3e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 1824*3e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 1825*3e469cdcSAndy Whitcroft # until we hit end of it. 1826*3e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 1827*3e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 1828*3e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 1829*3e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 1830*3e469cdcSAndy Whitcroft } 1831f74bd194SAndy Whitcroft 18322b474a1aSAndy Whitcroft # Find the real next line. 18332b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 18342b474a1aSAndy Whitcroft if (defined $realline_next && 18352b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 18362b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 18372b474a1aSAndy Whitcroft $realline_next++; 18382b474a1aSAndy Whitcroft } 18392b474a1aSAndy Whitcroft 1840171ae1a4SAndy Whitcroft my $s = $stat; 1841171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 1842cf655043SAndy Whitcroft 1843c2fdda0dSAndy Whitcroft # Ignore goto labels. 1844171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 1845c2fdda0dSAndy Whitcroft 1846c2fdda0dSAndy Whitcroft # Ignore functions being called 1847171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 1848c2fdda0dSAndy Whitcroft 1849463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 1850463f2864SAndy Whitcroft 1851c45dcabdSAndy Whitcroft # declarations always start with types 1852d2506586SAndy 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) { 1853c45dcabdSAndy Whitcroft my $type = $1; 1854c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 1855c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 1856c45dcabdSAndy Whitcroft 18576c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 1858a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 1859c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 1860c2fdda0dSAndy Whitcroft } 18618905a67cSAndy Whitcroft 18626c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 186365863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 1864c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 18659c0ca6f9SAndy Whitcroft } 18668905a67cSAndy Whitcroft 18678905a67cSAndy Whitcroft # Check for any sort of function declaration. 18688905a67cSAndy Whitcroft # int foo(something bar, other baz); 18698905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 1870171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 18718905a67cSAndy Whitcroft my ($name_len) = length($1); 18728905a67cSAndy Whitcroft 1873cf655043SAndy Whitcroft my $ctx = $s; 1874773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 18758905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 1876cf655043SAndy Whitcroft 18778905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 1878c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 18798905a67cSAndy Whitcroft 1880c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 18818905a67cSAndy Whitcroft } 18828905a67cSAndy Whitcroft } 18838905a67cSAndy Whitcroft } 18848905a67cSAndy Whitcroft 18859c0ca6f9SAndy Whitcroft } 18869c0ca6f9SAndy Whitcroft 188700df344fSAndy Whitcroft# 188800df344fSAndy Whitcroft# Checks which may be anchored in the context. 188900df344fSAndy Whitcroft# 189000df344fSAndy Whitcroft 189100df344fSAndy Whitcroft# Check for switch () and associated case and default 189200df344fSAndy Whitcroft# statements should be at the same indent. 189300df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 189400df344fSAndy Whitcroft my $err = ''; 189500df344fSAndy Whitcroft my $sep = ''; 189600df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 189700df344fSAndy Whitcroft shift(@ctx); 189800df344fSAndy Whitcroft for my $ctx (@ctx) { 189900df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 190000df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 190100df344fSAndy Whitcroft $indent != $cindent) { 190200df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 190300df344fSAndy Whitcroft $sep = ''; 190400df344fSAndy Whitcroft } else { 190500df344fSAndy Whitcroft $sep = "[...]\n"; 190600df344fSAndy Whitcroft } 190700df344fSAndy Whitcroft } 190800df344fSAndy Whitcroft if ($err ne '') { 1909000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 1910000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 1911de7d4f0eSAndy Whitcroft } 1912de7d4f0eSAndy Whitcroft } 1913de7d4f0eSAndy Whitcroft 1914de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 1915de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 1916c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 1917773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 1918773647a0SAndy Whitcroft 19199c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 1920de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 1921de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 1922de7d4f0eSAndy Whitcroft 1923548596d5SAndy Whitcroft my $ctx_ln = $linenr; 1924548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 1925de7d4f0eSAndy Whitcroft 1926548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 1927548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 1928548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 1929548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 1930548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 1931773647a0SAndy Whitcroft $ctx_ln++; 1932773647a0SAndy Whitcroft } 1933548596d5SAndy Whitcroft 193453210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 193553210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 1936773647a0SAndy Whitcroft 1937773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 1938000d1cc1SJoe Perches ERROR("OPEN_BRACE", 1939000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 194001464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 194100df344fSAndy Whitcroft } 1942773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 1943773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 1944773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 1945773647a0SAndy Whitcroft { 19469c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 19479c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 1948000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 1949000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 195001464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 19519c0ca6f9SAndy Whitcroft } 19529c0ca6f9SAndy Whitcroft } 195300df344fSAndy Whitcroft } 195400df344fSAndy Whitcroft 19554d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 19564d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 1957*3e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 1958*3e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 1959*3e469cdcSAndy Whitcroft if (!defined $stat); 19604d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 19614d001e4dSAndy Whitcroft 19624d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 19634d001e4dSAndy Whitcroft 19644d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 19654d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 19664d001e4dSAndy Whitcroft # where necessary. 19674d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 19684d001e4dSAndy Whitcroft 19694d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 19706f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 19716f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 19724d001e4dSAndy Whitcroft 19734d001e4dSAndy Whitcroft # We want to check the first line inside the block 19744d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 19754d001e4dSAndy Whitcroft # 1) any blank line termination 19764d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 19774d001e4dSAndy Whitcroft # 3) any do (...) { 19784d001e4dSAndy Whitcroft my $continuation = 0; 19794d001e4dSAndy Whitcroft my $check = 0; 19804d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 19814d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 19824d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 19834d001e4dSAndy Whitcroft $continuation = 1; 19844d001e4dSAndy Whitcroft } 19859bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 19864d001e4dSAndy Whitcroft $check = 1; 19874d001e4dSAndy Whitcroft $cond_lines++; 19884d001e4dSAndy Whitcroft } 19894d001e4dSAndy Whitcroft 19904d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 19914d001e4dSAndy Whitcroft # preprocessor statement. 19924d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 19934d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 19944d001e4dSAndy Whitcroft $check = 0; 19954d001e4dSAndy Whitcroft } 19964d001e4dSAndy Whitcroft 19979bd49efeSAndy Whitcroft my $cond_ptr = -1; 1998740504c6SAndy Whitcroft $continuation = 0; 19999bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 20009bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 20014d001e4dSAndy Whitcroft 2002f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2003f16fa28fSAndy Whitcroft # is not linear. 2004f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2005f16fa28fSAndy Whitcroft $check = 0; 2006f16fa28fSAndy Whitcroft } 2007f16fa28fSAndy Whitcroft 20089bd49efeSAndy Whitcroft # Ignore: 20099bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 20109bd49efeSAndy Whitcroft # 2) preprocessor lines, and 20119bd49efeSAndy Whitcroft # 3) labels. 2012740504c6SAndy Whitcroft if ($continuation || 2013740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 20149bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 20159bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 2016740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 201730dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 20189bd49efeSAndy Whitcroft $cond_lines++; 20199bd49efeSAndy Whitcroft } 20204d001e4dSAndy Whitcroft } 202130dad6ebSAndy Whitcroft } 20224d001e4dSAndy Whitcroft 20234d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 20244d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 20254d001e4dSAndy Whitcroft 20264d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 20274d001e4dSAndy Whitcroft # this is not this patch's fault. 20284d001e4dSAndy Whitcroft if (!defined($stat_real) || 20294d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 20304d001e4dSAndy Whitcroft $check = 0; 20314d001e4dSAndy Whitcroft } 20324d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 20334d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 20344d001e4dSAndy Whitcroft } 20354d001e4dSAndy Whitcroft 20369bd49efeSAndy 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"; 20374d001e4dSAndy Whitcroft 20384d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 20394d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 2040000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 2041000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 20424d001e4dSAndy Whitcroft } 20434d001e4dSAndy Whitcroft } 20444d001e4dSAndy Whitcroft 20456c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 20466c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 20471f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 20481f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 20496c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2050c2fdda0dSAndy Whitcroft if ($dbg_values) { 2051c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2052cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2053cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 20541f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2055c2fdda0dSAndy Whitcroft } 20566c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 20576c72ffaaSAndy Whitcroft 205800df344fSAndy Whitcroft#ignore lines not being added 205900df344fSAndy Whitcroft if ($line=~/^[^\+]/) {next;} 206000df344fSAndy Whitcroft 2061653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 20627429c690SAndy Whitcroft if ($dbg_type) { 20637429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2064000d1cc1SJoe Perches ERROR("TEST_TYPE", 2065000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 20667429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2067000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2068000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 20697429c690SAndy Whitcroft } 2070653d4876SAndy Whitcroft next; 2071653d4876SAndy Whitcroft } 2072a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2073a1ef277eSAndy Whitcroft if ($dbg_attr) { 20749360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2075000d1cc1SJoe Perches ERROR("TEST_ATTR", 2076000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 20779360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2078000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2079000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2080a1ef277eSAndy Whitcroft } 2081a1ef277eSAndy Whitcroft next; 2082a1ef277eSAndy Whitcroft } 2083653d4876SAndy Whitcroft 2084f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 208599423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 208699423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2087000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2088000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . $hereprev); 2089f0a594c1SAndy Whitcroft } 2090f0a594c1SAndy Whitcroft 209100df344fSAndy Whitcroft# 209200df344fSAndy Whitcroft# Checks which are anchored on the added line. 209300df344fSAndy Whitcroft# 209400df344fSAndy Whitcroft 2095653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 2096c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2097653d4876SAndy Whitcroft my $path = $1; 2098653d4876SAndy Whitcroft if ($path =~ m{//}) { 2099000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 2100000d1cc1SJoe Perches "malformed #include filename\n" . 2101de7d4f0eSAndy Whitcroft $herecurr); 2102653d4876SAndy Whitcroft } 2103653d4876SAndy Whitcroft } 2104653d4876SAndy Whitcroft 210500df344fSAndy Whitcroft# no C99 // comments 210600df344fSAndy Whitcroft if ($line =~ m{//}) { 2107000d1cc1SJoe Perches ERROR("C99_COMMENTS", 2108000d1cc1SJoe Perches "do not use C99 // comments\n" . $herecurr); 210900df344fSAndy Whitcroft } 211000df344fSAndy Whitcroft # Remove C99 comments. 21110a920b5bSAndy Whitcroft $line =~ s@//.*@@; 21126c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 21130a920b5bSAndy Whitcroft 21142b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 21152b474a1aSAndy Whitcroft# the whole statement. 21162b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 21172b474a1aSAndy Whitcroft if (defined $realline_next && 21182b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 21192b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 21202b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 21212b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 21223cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 21233cbf62dfSAndy Whitcroft # a prefix: 21243cbf62dfSAndy Whitcroft # XXX(foo); 21253cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 2126653d4876SAndy Whitcroft my $name = $1; 21273cbf62dfSAndy Whitcroft if ($stat =~ /^.([A-Z_]+)\s*\(\s*($Ident)/ && 21283cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 21293cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 21303cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 21313cbf62dfSAndy Whitcroft 21323cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 21332b474a1aSAndy Whitcroft \n.}\s*$| 213448012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 213548012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 213648012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 21372b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 21382b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 213948012058SAndy Whitcroft )/x) { 21402b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 21412b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 21422b474a1aSAndy Whitcroft } else { 21432b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 21440a920b5bSAndy Whitcroft } 21450a920b5bSAndy Whitcroft } 21462b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 21472b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 21482b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 21492b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 21502b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 21512b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 21522b474a1aSAndy Whitcroft } 21532b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 21542b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 2155000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 2156000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 21572b474a1aSAndy Whitcroft } 21580a920b5bSAndy Whitcroft 21595150bda4SJoe Eloff# check for global initialisers. 2160c45dcabdSAndy Whitcroft if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { 2161000d1cc1SJoe Perches ERROR("GLOBAL_INITIALISERS", 2162000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 2163f0a594c1SAndy Whitcroft $herecurr); 2164f0a594c1SAndy Whitcroft } 21650a920b5bSAndy Whitcroft# check for static initialisers. 21662d1bafd7SAndy Whitcroft if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2167000d1cc1SJoe Perches ERROR("INITIALISED_STATIC", 2168000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 2169de7d4f0eSAndy Whitcroft $herecurr); 21700a920b5bSAndy Whitcroft } 21710a920b5bSAndy Whitcroft 2172cb710ecaSJoe Perches# check for static const char * arrays. 2173cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2174000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2175000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 2176cb710ecaSJoe Perches $herecurr); 2177cb710ecaSJoe Perches } 2178cb710ecaSJoe Perches 2179cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 2180cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2181000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2182000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 2183cb710ecaSJoe Perches $herecurr); 2184cb710ecaSJoe Perches } 2185cb710ecaSJoe Perches 218693ed0e2dSJoe Perches# check for declarations of struct pci_device_id 218793ed0e2dSJoe Perches if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) { 2188000d1cc1SJoe Perches WARN("DEFINE_PCI_DEVICE_TABLE", 2189000d1cc1SJoe Perches "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr); 219093ed0e2dSJoe Perches } 219193ed0e2dSJoe Perches 2192653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 2193653d4876SAndy Whitcroft# make sense. 2194653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 21958054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 2196c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 21978ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 2198653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 2199000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 2200000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 22010a920b5bSAndy Whitcroft } 22020a920b5bSAndy Whitcroft 22030a920b5bSAndy Whitcroft# * goes on variable not on type 220465863862SAndy Whitcroft # (char*[ const]) 220500ef4eceSAndy Whitcroft if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) { 220665863862SAndy Whitcroft my ($from, $to) = ($1, $1); 2207d8aaf121SAndy Whitcroft 220865863862SAndy Whitcroft # Should start with a space. 220965863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 221065863862SAndy Whitcroft # Should not end with a space. 221165863862SAndy Whitcroft $to =~ s/\s+$//; 221265863862SAndy Whitcroft # '*'s should not have spaces between. 2213f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 221465863862SAndy Whitcroft } 2215d8aaf121SAndy Whitcroft 221665863862SAndy Whitcroft #print "from<$from> to<$to>\n"; 221765863862SAndy Whitcroft if ($from ne $to) { 2218000d1cc1SJoe Perches ERROR("POINTER_LOCATION", 2219000d1cc1SJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); 222065863862SAndy Whitcroft } 222100ef4eceSAndy Whitcroft } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) { 222265863862SAndy Whitcroft my ($from, $to, $ident) = ($1, $1, $2); 2223d8aaf121SAndy Whitcroft 222465863862SAndy Whitcroft # Should start with a space. 222565863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 222665863862SAndy Whitcroft # Should not end with a space. 222765863862SAndy Whitcroft $to =~ s/\s+$//; 222865863862SAndy Whitcroft # '*'s should not have spaces between. 2229f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 223065863862SAndy Whitcroft } 223165863862SAndy Whitcroft # Modifiers should have spaces. 223265863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 223365863862SAndy Whitcroft 2234667026e7SAndy Whitcroft #print "from<$from> to<$to> ident<$ident>\n"; 2235667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 2236000d1cc1SJoe Perches ERROR("POINTER_LOCATION", 2237000d1cc1SJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); 223865863862SAndy Whitcroft } 22390a920b5bSAndy Whitcroft } 22400a920b5bSAndy Whitcroft 22410a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 22420a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 22430a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 22440a920b5bSAndy Whitcroft# print "$herecurr"; 22450a920b5bSAndy Whitcroft# $clean = 0; 22460a920b5bSAndy Whitcroft# } 22470a920b5bSAndy Whitcroft 22488905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 2249000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 2250000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 22518905a67cSAndy Whitcroft } 22528905a67cSAndy Whitcroft 225317441227SJoe Perches# check for uses of printk_ratelimit 225417441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 2255000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 2256000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 225717441227SJoe Perches } 225817441227SJoe Perches 225900df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 226000df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 226100df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 226225985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 226300df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 2264f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 226500df344fSAndy Whitcroft my $ok = 0; 226600df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 226700df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 226825985edcSLucas De Marchi # we have a preceding printk if it ends 226900df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 227000df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 227100df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 227200df344fSAndy Whitcroft $ok = 1; 227300df344fSAndy Whitcroft } 227400df344fSAndy Whitcroft last; 227500df344fSAndy Whitcroft } 227600df344fSAndy Whitcroft } 227700df344fSAndy Whitcroft if ($ok == 0) { 2278000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 2279000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 22800a920b5bSAndy Whitcroft } 228100df344fSAndy Whitcroft } 22820a920b5bSAndy Whitcroft 2283653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 2284653d4876SAndy Whitcroft# or if closed on same line 2285c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 2286c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 2287000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2288000d1cc1SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr); 22890a920b5bSAndy Whitcroft } 2290653d4876SAndy Whitcroft 22918905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 22928905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 22938905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2294000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2295000d1cc1SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev); 22968905a67cSAndy Whitcroft } 22978905a67cSAndy Whitcroft 22980c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 22990c73b4ebSAndy Whitcroft if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) { 2300000d1cc1SJoe Perches WARN("SPACING", 2301000d1cc1SJoe Perches "missing space after $1 definition\n" . $herecurr); 23020c73b4ebSAndy Whitcroft } 23030c73b4ebSAndy Whitcroft 23048d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 23058d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 2306fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 2307fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 23088d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 23098d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 23108d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 2311fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 2312fe2a7dbcSAndy Whitcroft $prefix !~ /{\s+$/) { 2313000d1cc1SJoe Perches ERROR("BRACKET_SPACE", 2314000d1cc1SJoe Perches "space prohibited before open square bracket '['\n" . $herecurr); 23158d31cfceSAndy Whitcroft } 23168d31cfceSAndy Whitcroft } 23178d31cfceSAndy Whitcroft 2318f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 23196c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 2320c2fdda0dSAndy Whitcroft my $name = $1; 2321773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 2322773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 2323c2fdda0dSAndy Whitcroft 2324c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 2325773647a0SAndy Whitcroft if ($name =~ /^(?: 2326773647a0SAndy Whitcroft if|for|while|switch|return|case| 2327773647a0SAndy Whitcroft volatile|__volatile__| 2328773647a0SAndy Whitcroft __attribute__|format|__extension__| 2329773647a0SAndy Whitcroft asm|__asm__)$/x) 2330773647a0SAndy Whitcroft { 2331c2fdda0dSAndy Whitcroft 2332c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 2333c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 2334c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 2335c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 2336773647a0SAndy Whitcroft 2337773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 2338c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 2339c2fdda0dSAndy Whitcroft 2340c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 2341c2fdda0dSAndy Whitcroft # likely a typedef for a function. 2342773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 2343c2fdda0dSAndy Whitcroft 2344c2fdda0dSAndy Whitcroft } else { 2345000d1cc1SJoe Perches WARN("SPACING", 2346000d1cc1SJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr); 2347f0a594c1SAndy Whitcroft } 23486c72ffaaSAndy Whitcroft } 2349653d4876SAndy Whitcroft# Check operator spacing. 23500a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 23519c0ca6f9SAndy Whitcroft my $ops = qr{ 23529c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 23539c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 23549c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 23551f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 23561f65f947SAndy Whitcroft \?|: 23579c0ca6f9SAndy Whitcroft }x; 2358cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 235900df344fSAndy Whitcroft my $off = 0; 23606c72ffaaSAndy Whitcroft 23616c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 23626c72ffaaSAndy Whitcroft 23630a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 23644a0df2efSAndy Whitcroft $off += length($elements[$n]); 23654a0df2efSAndy Whitcroft 236625985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 2367773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 2368773647a0SAndy Whitcroft my $cc = ''; 2369773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 2370773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 2371773647a0SAndy Whitcroft } 2372773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 2373773647a0SAndy Whitcroft 23744a0df2efSAndy Whitcroft my $a = ''; 23754a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 23764a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 2377cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 23784a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 23794a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 2380773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 23814a0df2efSAndy Whitcroft 23820a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 23834a0df2efSAndy Whitcroft 23844a0df2efSAndy Whitcroft my $c = ''; 23850a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 23864a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 23874a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 2388cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 23894a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 23904a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 23918b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 23924a0df2efSAndy Whitcroft } else { 23934a0df2efSAndy Whitcroft $c = 'E'; 23940a920b5bSAndy Whitcroft } 23950a920b5bSAndy Whitcroft 23964a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 23974a0df2efSAndy Whitcroft 23984a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 23994a0df2efSAndy Whitcroft 24006c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 2401de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 24020a920b5bSAndy Whitcroft 240374048ed8SAndy Whitcroft # Pull out the value of this operator. 24046c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 24050a920b5bSAndy Whitcroft 24061f65f947SAndy Whitcroft # Get the full operator variant. 24071f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 24081f65f947SAndy Whitcroft 240913214adfSAndy Whitcroft # Ignore operators passed as parameters. 241013214adfSAndy Whitcroft if ($op_type ne 'V' && 241113214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 241213214adfSAndy Whitcroft 2413cf655043SAndy Whitcroft# # Ignore comments 2414cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 241513214adfSAndy Whitcroft 2416d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 241713214adfSAndy Whitcroft } elsif ($op eq ';') { 2418cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 2419cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 2420000d1cc1SJoe Perches ERROR("SPACING", 2421000d1cc1SJoe Perches "space required after that '$op' $at\n" . $hereptr); 2422d8aaf121SAndy Whitcroft } 2423d8aaf121SAndy Whitcroft 2424d8aaf121SAndy Whitcroft # // is a comment 2425d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 24260a920b5bSAndy Whitcroft 24271f65f947SAndy Whitcroft # No spaces for: 24281f65f947SAndy Whitcroft # -> 24291f65f947SAndy Whitcroft # : when part of a bitfield 24301f65f947SAndy Whitcroft } elsif ($op eq '->' || $opv eq ':B') { 24314a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 2432000d1cc1SJoe Perches ERROR("SPACING", 2433000d1cc1SJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr); 24340a920b5bSAndy Whitcroft } 24350a920b5bSAndy Whitcroft 24360a920b5bSAndy Whitcroft # , must have a space on the right. 24370a920b5bSAndy Whitcroft } elsif ($op eq ',') { 2438cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 2439000d1cc1SJoe Perches ERROR("SPACING", 2440000d1cc1SJoe Perches "space required after that '$op' $at\n" . $hereptr); 24410a920b5bSAndy Whitcroft } 24420a920b5bSAndy Whitcroft 24439c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 244474048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 24459c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 24469c0ca6f9SAndy Whitcroft 24479c0ca6f9SAndy Whitcroft # unary operators should have a space before and 24489c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 24499c0ca6f9SAndy Whitcroft # unary operator, or a cast 24509c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 245174048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 24520d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 2453cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 2454000d1cc1SJoe Perches ERROR("SPACING", 2455000d1cc1SJoe Perches "space required before that '$op' $at\n" . $hereptr); 24560a920b5bSAndy Whitcroft } 2457a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 2458171ae1a4SAndy Whitcroft # A unary '*' may be const 2459171ae1a4SAndy Whitcroft 2460171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 2461000d1cc1SJoe Perches ERROR("SPACING", 2462000d1cc1SJoe Perches "space prohibited after that '$op' $at\n" . $hereptr); 24630a920b5bSAndy Whitcroft } 24640a920b5bSAndy Whitcroft 24650a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 24660a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 2467773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 2468000d1cc1SJoe Perches ERROR("SPACING", 2469000d1cc1SJoe Perches "space required one side of that '$op' $at\n" . $hereptr); 24700a920b5bSAndy Whitcroft } 2471773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 2472773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 2473000d1cc1SJoe Perches ERROR("SPACING", 2474000d1cc1SJoe Perches "space prohibited before that '$op' $at\n" . $hereptr); 2475653d4876SAndy Whitcroft } 2476773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 2477000d1cc1SJoe Perches ERROR("SPACING", 2478000d1cc1SJoe Perches "space prohibited after that '$op' $at\n" . $hereptr); 2479773647a0SAndy Whitcroft } 2480773647a0SAndy Whitcroft 24810a920b5bSAndy Whitcroft 24820a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 24839c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 24849c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 24859c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 2486c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 2487c2fdda0dSAndy Whitcroft $op eq '%') 24880a920b5bSAndy Whitcroft { 2489773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 2490000d1cc1SJoe Perches ERROR("SPACING", 2491000d1cc1SJoe Perches "need consistent spacing around '$op' $at\n" . 2492de7d4f0eSAndy Whitcroft $hereptr); 24930a920b5bSAndy Whitcroft } 24940a920b5bSAndy Whitcroft 24951f65f947SAndy Whitcroft # A colon needs no spaces before when it is 24961f65f947SAndy Whitcroft # terminating a case value or a label. 24971f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 24981f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 2499000d1cc1SJoe Perches ERROR("SPACING", 2500000d1cc1SJoe Perches "space prohibited before that '$op' $at\n" . $hereptr); 25011f65f947SAndy Whitcroft } 25021f65f947SAndy Whitcroft 25030a920b5bSAndy Whitcroft # All the others need spaces both sides. 2504cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 25051f65f947SAndy Whitcroft my $ok = 0; 25061f65f947SAndy Whitcroft 250722f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 25081f65f947SAndy Whitcroft if (($op eq '<' && 25091f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 25101f65f947SAndy Whitcroft ($op eq '>' && 25111f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 25121f65f947SAndy Whitcroft { 25131f65f947SAndy Whitcroft $ok = 1; 25141f65f947SAndy Whitcroft } 25151f65f947SAndy Whitcroft 25161f65f947SAndy Whitcroft # Ignore ?: 25171f65f947SAndy Whitcroft if (($opv eq ':O' && $ca =~ /\?$/) || 25181f65f947SAndy Whitcroft ($op eq '?' && $cc =~ /^:/)) { 25191f65f947SAndy Whitcroft $ok = 1; 25201f65f947SAndy Whitcroft } 25211f65f947SAndy Whitcroft 25221f65f947SAndy Whitcroft if ($ok == 0) { 2523000d1cc1SJoe Perches ERROR("SPACING", 2524000d1cc1SJoe Perches "spaces required around that '$op' $at\n" . $hereptr); 25250a920b5bSAndy Whitcroft } 252622f2a2efSAndy Whitcroft } 25274a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 25280a920b5bSAndy Whitcroft } 25290a920b5bSAndy Whitcroft } 25300a920b5bSAndy Whitcroft 2531f0a594c1SAndy Whitcroft# check for multiple assignments 2532f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 2533000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 2534000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 2535f0a594c1SAndy Whitcroft } 2536f0a594c1SAndy Whitcroft 253722f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 253822f2a2efSAndy Whitcroft## # continuation. 253922f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 254022f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 254122f2a2efSAndy Whitcroft## 254222f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 254322f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 254422f2a2efSAndy Whitcroft## my $ln = $line; 254522f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 254622f2a2efSAndy Whitcroft## } 254722f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 2548000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 2549000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 255022f2a2efSAndy Whitcroft## } 255122f2a2efSAndy Whitcroft## } 2552f0a594c1SAndy Whitcroft 25530a920b5bSAndy Whitcroft#need space before brace following if, while, etc 255422f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 255522f2a2efSAndy Whitcroft $line =~ /do{/) { 2556000d1cc1SJoe Perches ERROR("SPACING", 2557000d1cc1SJoe Perches "space required before the open brace '{'\n" . $herecurr); 2558de7d4f0eSAndy Whitcroft } 2559de7d4f0eSAndy Whitcroft 2560de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 2561de7d4f0eSAndy Whitcroft# on the line 2562de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 2563000d1cc1SJoe Perches ERROR("SPACING", 2564000d1cc1SJoe Perches "space required after that close brace '}'\n" . $herecurr); 25650a920b5bSAndy Whitcroft } 25660a920b5bSAndy Whitcroft 256722f2a2efSAndy Whitcroft# check spacing on square brackets 256822f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 2569000d1cc1SJoe Perches ERROR("SPACING", 2570000d1cc1SJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr); 257122f2a2efSAndy Whitcroft } 257222f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 2573000d1cc1SJoe Perches ERROR("SPACING", 2574000d1cc1SJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr); 257522f2a2efSAndy Whitcroft } 257622f2a2efSAndy Whitcroft 2577c45dcabdSAndy Whitcroft# check spacing on parentheses 25789c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 25799c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 2580000d1cc1SJoe Perches ERROR("SPACING", 2581000d1cc1SJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr); 258222f2a2efSAndy Whitcroft } 258313214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 2584c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 2585c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 2586000d1cc1SJoe Perches ERROR("SPACING", 2587000d1cc1SJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr); 258822f2a2efSAndy Whitcroft } 258922f2a2efSAndy Whitcroft 25900a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 25914a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 25920a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 2593000d1cc1SJoe Perches WARN("INDENTED_LABEL", 2594000d1cc1SJoe Perches "labels should not be indented\n" . $herecurr); 25950a920b5bSAndy Whitcroft } 25960a920b5bSAndy Whitcroft 2597c45dcabdSAndy Whitcroft# Return is not a function. 2598c45dcabdSAndy Whitcroft if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { 2599c45dcabdSAndy Whitcroft my $spacing = $1; 2600c45dcabdSAndy Whitcroft my $value = $2; 2601c45dcabdSAndy Whitcroft 260286f9d059SAndy Whitcroft # Flatten any parentheses 2603fb2d2c1bSAndy Whitcroft $value =~ s/\(/ \(/g; 2604fb2d2c1bSAndy Whitcroft $value =~ s/\)/\) /g; 260563f17f89SAndy Whitcroft while ($value =~ s/\[[^\{\}]*\]/1/ || 260663f17f89SAndy Whitcroft $value !~ /(?:$Ident|-?$Constant)\s* 260763f17f89SAndy Whitcroft $Compare\s* 260863f17f89SAndy Whitcroft (?:$Ident|-?$Constant)/x && 260963f17f89SAndy Whitcroft $value =~ s/\([^\(\)]*\)/1/) { 2610c45dcabdSAndy Whitcroft } 2611fb2d2c1bSAndy Whitcroft#print "value<$value>\n"; 2612fb2d2c1bSAndy Whitcroft if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) { 2613000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 2614000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 2615c45dcabdSAndy Whitcroft 2616c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 2617000d1cc1SJoe Perches ERROR("SPACING", 2618000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 2619c45dcabdSAndy Whitcroft } 2620c45dcabdSAndy Whitcroft } 262153a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 262253a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 262353a3c448SAndy Whitcroft my $name = $1; 262453a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 2625000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 2626000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 262753a3c448SAndy Whitcroft } 262853a3c448SAndy Whitcroft } 2629c45dcabdSAndy Whitcroft 26300a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 26314a0df2efSAndy Whitcroft if ($line=~/\b(if|while|for|switch)\(/) { 2632000d1cc1SJoe Perches ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr); 26330a920b5bSAndy Whitcroft } 26340a920b5bSAndy Whitcroft 2635f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 2636f5fe35ddSAndy Whitcroft# statements after the conditional. 2637170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 2638*3e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2639*3e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 2640*3e469cdcSAndy Whitcroft if (!defined $stat); 2641170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 2642170d3a22SAndy Whitcroft $remain_next, $off_next); 2643170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 2644170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 2645170d3a22SAndy Whitcroft 2646170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 2647170d3a22SAndy Whitcroft # If the statement carries leading newlines, 2648170d3a22SAndy Whitcroft # then count those as offsets. 2649170d3a22SAndy Whitcroft my ($whitespace) = 2650170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 2651170d3a22SAndy Whitcroft my $offset = 2652170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 2653170d3a22SAndy Whitcroft 2654170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 2655170d3a22SAndy Whitcroft $offset} = 1; 2656170d3a22SAndy Whitcroft } 2657170d3a22SAndy Whitcroft } 2658170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 2659170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 2660171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 26618905a67cSAndy Whitcroft 2662b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 2663000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 2664000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 26658905a67cSAndy Whitcroft } 26668905a67cSAndy Whitcroft 26678905a67cSAndy Whitcroft # Find out what is on the end of the line after the 26688905a67cSAndy Whitcroft # conditional. 2669773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 26708905a67cSAndy Whitcroft $s =~ s/\n.*//g; 267113214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 267253210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 267353210168SAndy Whitcroft $c !~ /}\s*while\s*/) 2674773647a0SAndy Whitcroft { 2675bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 2676bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 2677bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 267842bdf74cSHidetoshi Seto my $stat_real = ''; 2679bb44ad39SAndy Whitcroft 268042bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 268142bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 2682bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 2683bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 2684bb44ad39SAndy Whitcroft } 2685bb44ad39SAndy Whitcroft 2686000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2687000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 26888905a67cSAndy Whitcroft } 26898905a67cSAndy Whitcroft } 26908905a67cSAndy Whitcroft 269113214adfSAndy Whitcroft# Check for bitwise tests written as boolean 269213214adfSAndy Whitcroft if ($line =~ / 269313214adfSAndy Whitcroft (?: 269413214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 269513214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 269613214adfSAndy Whitcroft (?:\&\&|\|\|) 269713214adfSAndy Whitcroft | 269813214adfSAndy Whitcroft (?:\&\&|\|\|) 269913214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 270013214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 270113214adfSAndy Whitcroft )/x) 270213214adfSAndy Whitcroft { 2703000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 2704000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 270513214adfSAndy Whitcroft } 270613214adfSAndy Whitcroft 27078905a67cSAndy Whitcroft# if and else should not have general statements after it 270813214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 270913214adfSAndy Whitcroft my $s = $1; 271013214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 271113214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 2712000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2713000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 27140a920b5bSAndy Whitcroft } 271513214adfSAndy Whitcroft } 271639667782SAndy Whitcroft# if should not continue a brace 271739667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 2718000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2719000d1cc1SJoe Perches "trailing statements should be on next line\n" . 272039667782SAndy Whitcroft $herecurr); 272139667782SAndy Whitcroft } 2722a1080bf8SAndy Whitcroft# case and default should not have general statements after them 2723a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 2724a1080bf8SAndy Whitcroft $line !~ /\G(?: 27253fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 2726a1080bf8SAndy Whitcroft \s*return\s+ 2727a1080bf8SAndy Whitcroft )/xg) 2728a1080bf8SAndy Whitcroft { 2729000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 2730000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 2731a1080bf8SAndy Whitcroft } 27320a920b5bSAndy Whitcroft 27330a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 27340a920b5bSAndy Whitcroft # indent level to be relevant to each other. 27350a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 27360a920b5bSAndy Whitcroft $previndent == $indent) { 2737000d1cc1SJoe Perches ERROR("ELSE_AFTER_BRACE", 2738000d1cc1SJoe Perches "else should follow close brace '}'\n" . $hereprev); 27390a920b5bSAndy Whitcroft } 27400a920b5bSAndy Whitcroft 2741c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 2742c2fdda0dSAndy Whitcroft $previndent == $indent) { 2743c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 2744c2fdda0dSAndy Whitcroft 2745c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 2746c2fdda0dSAndy Whitcroft # conditional. 2747773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 2748c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 2749c2fdda0dSAndy Whitcroft 2750c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 2751000d1cc1SJoe Perches ERROR("WHILE_AFTER_BRACE", 2752000d1cc1SJoe Perches "while should follow close brace '}'\n" . $hereprev); 2753c2fdda0dSAndy Whitcroft } 2754c2fdda0dSAndy Whitcroft } 2755c2fdda0dSAndy Whitcroft 27560a920b5bSAndy Whitcroft#studly caps, commented out until figure out how to distinguish between use of existing and adding new 27570a920b5bSAndy Whitcroft# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) { 27580a920b5bSAndy Whitcroft# print "No studly caps, use _\n"; 27590a920b5bSAndy Whitcroft# print "$herecurr"; 27600a920b5bSAndy Whitcroft# $clean = 0; 27610a920b5bSAndy Whitcroft# } 27620a920b5bSAndy Whitcroft 27630a920b5bSAndy Whitcroft#no spaces allowed after \ in define 2764c45dcabdSAndy Whitcroft if ($line=~/\#\s*define.*\\\s$/) { 2765000d1cc1SJoe Perches WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 2766000d1cc1SJoe Perches "Whitepspace after \\ makes next lines useless\n" . $herecurr); 27670a920b5bSAndy Whitcroft } 27680a920b5bSAndy Whitcroft 2769653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 2770c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 2771e09dec48SAndy Whitcroft my $file = "$1.h"; 2772e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 2773e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 2774e09dec48SAndy Whitcroft $realfile ne $checkfile && 27757840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 2776c45dcabdSAndy Whitcroft { 2777e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 2778000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 2779000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2780e09dec48SAndy Whitcroft } else { 2781000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 2782000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 2783e09dec48SAndy Whitcroft } 27840a920b5bSAndy Whitcroft } 27850a920b5bSAndy Whitcroft } 27860a920b5bSAndy Whitcroft 2787653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 2788653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 2789cf655043SAndy Whitcroft# in a known good container 2790b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 2791b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 2792d8aaf121SAndy Whitcroft my $ln = $linenr; 2793d8aaf121SAndy Whitcroft my $cnt = $realcnt; 2794c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 2795c45dcabdSAndy Whitcroft my $ctx = ''; 2796c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 2797f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2798f74bd194SAndy Whitcroft $ctx = $dstat; 2799c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 2800a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 2801c45dcabdSAndy Whitcroft 2802f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 2803292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 2804c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 2805c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 2806c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 2807c45dcabdSAndy Whitcroft 2808c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 2809bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 2810bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 2811bf30d6edSAndy Whitcroft $dstat =~ s/\[[^\{\}]*\]/1/) 2812bf30d6edSAndy Whitcroft { 2813c45dcabdSAndy Whitcroft } 2814c45dcabdSAndy Whitcroft 2815c45dcabdSAndy Whitcroft my $exceptions = qr{ 2816c45dcabdSAndy Whitcroft $Declare| 2817c45dcabdSAndy Whitcroft module_param_named| 2818c45dcabdSAndy Whitcroft MODULE_PARAM_DESC| 2819c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 2820c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 2821383099fdSAndy Whitcroft __typeof__\(| 282222fd2d3eSStefani Seibold union| 282322fd2d3eSStefani Seibold struct| 2824ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 2825ea71a0a0SAndy Whitcroft ^\"|\"$ 2826c45dcabdSAndy Whitcroft }x; 28275eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 2828f74bd194SAndy Whitcroft if ($dstat ne '' && 2829f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 2830f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 2831f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant)$/ && # 10 // foo() 2832f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 2833f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 2834f74bd194SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;$/ && # do {...} while (...); 2835f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 2836f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 2837f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 2838f74bd194SAndy Whitcroft $dstat !~ /^\({/) # ({... 2839c45dcabdSAndy Whitcroft { 2840f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 2841f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 2842f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 2843f74bd194SAndy Whitcroft 2844f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 2845f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 2846c45dcabdSAndy Whitcroft } 2847c45dcabdSAndy Whitcroft 2848f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 2849f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 2850f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 2851f74bd194SAndy Whitcroft } else { 2852000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 2853f74bd194SAndy Whitcroft "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); 2854d8aaf121SAndy Whitcroft } 28550a920b5bSAndy Whitcroft } 2856653d4876SAndy Whitcroft } 28570a920b5bSAndy Whitcroft 2858080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 2859080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 2860080ba929SMike Frysinger# . 2861080ba929SMike Frysinger# ALIGN(...) 2862080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 2863080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 2864000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 2865000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 2866080ba929SMike Frysinger } 2867080ba929SMike Frysinger 2868f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 286913214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 287013214adfSAndy Whitcroft my ($level, $endln, @chunks) = 2871cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 287213214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 2873cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 2874cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 287513214adfSAndy Whitcroft my $allowed = 0; 287613214adfSAndy Whitcroft my $seen = 0; 2877773647a0SAndy Whitcroft my $herectx = $here . "\n"; 2878cf655043SAndy Whitcroft my $ln = $linenr - 1; 287913214adfSAndy Whitcroft for my $chunk (@chunks) { 288013214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 288113214adfSAndy Whitcroft 2882773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 2883773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 2884773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 2885773647a0SAndy Whitcroft 2886773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 2887773647a0SAndy Whitcroft 2888773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 2889773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 2890773647a0SAndy Whitcroft 2891773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 2892cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 2893cf655043SAndy Whitcroft 2894773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 289513214adfSAndy Whitcroft 289613214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 289713214adfSAndy Whitcroft 2898cf655043SAndy Whitcroft #print "cond<$cond> block<$block> allowed<$allowed>\n"; 2899cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 2900cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 290113214adfSAndy Whitcroft $allowed = 1; 290213214adfSAndy Whitcroft } 290313214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 2904cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 290513214adfSAndy Whitcroft $allowed = 1; 290613214adfSAndy Whitcroft } 2907cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 2908cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 290913214adfSAndy Whitcroft $allowed = 1; 291013214adfSAndy Whitcroft } 291113214adfSAndy Whitcroft } 291213214adfSAndy Whitcroft if ($seen && !$allowed) { 2913000d1cc1SJoe Perches WARN("BRACES", 2914000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 291513214adfSAndy Whitcroft } 291613214adfSAndy Whitcroft } 291713214adfSAndy Whitcroft } 2918773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 291913214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 2920cf655043SAndy Whitcroft my $allowed = 0; 2921f0a594c1SAndy Whitcroft 2922cf655043SAndy Whitcroft # Check the pre-context. 2923cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 2924cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 2925cf655043SAndy Whitcroft $allowed = 1; 2926f0a594c1SAndy Whitcroft } 2927773647a0SAndy Whitcroft 2928773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 2929773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 2930773647a0SAndy Whitcroft 2931cf655043SAndy Whitcroft # Check the condition. 2932cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 2933773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 2934cf655043SAndy Whitcroft if (defined $cond) { 2935773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 2936cf655043SAndy Whitcroft } 2937cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 2938cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 2939cf655043SAndy Whitcroft $allowed = 1; 2940cf655043SAndy Whitcroft } 2941cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 2942cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 2943cf655043SAndy Whitcroft $allowed = 1; 2944cf655043SAndy Whitcroft } 2945cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 2946cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 2947cf655043SAndy Whitcroft $allowed = 1; 2948cf655043SAndy Whitcroft } 2949cf655043SAndy Whitcroft # Check the post-context. 2950cf655043SAndy Whitcroft if (defined $chunks[1]) { 2951cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 2952cf655043SAndy Whitcroft if (defined $cond) { 2953773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 2954cf655043SAndy Whitcroft } 2955cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 2956cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 2957cf655043SAndy Whitcroft $allowed = 1; 2958cf655043SAndy Whitcroft } 2959cf655043SAndy Whitcroft } 2960cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 296169932487SJustin P. Mattock my $herectx = $here . "\n"; 2962f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 2963cf655043SAndy Whitcroft 2964f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 296569932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 2966cf655043SAndy Whitcroft } 2967cf655043SAndy Whitcroft 2968000d1cc1SJoe Perches WARN("BRACES", 2969000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 2970f0a594c1SAndy Whitcroft } 2971f0a594c1SAndy Whitcroft } 2972f0a594c1SAndy Whitcroft 2973653d4876SAndy Whitcroft# don't include deprecated include files (uses RAW line) 29744a0df2efSAndy Whitcroft for my $inc (@dep_includes) { 2975c45dcabdSAndy Whitcroft if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) { 2976000d1cc1SJoe Perches ERROR("DEPRECATED_INCLUDE", 2977000d1cc1SJoe Perches "Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr); 29780a920b5bSAndy Whitcroft } 29790a920b5bSAndy Whitcroft } 29800a920b5bSAndy Whitcroft 29814a0df2efSAndy Whitcroft# don't use deprecated functions 29824a0df2efSAndy Whitcroft for my $func (@dep_functions) { 298300df344fSAndy Whitcroft if ($line =~ /\b$func\b/) { 2984000d1cc1SJoe Perches ERROR("DEPRECATED_FUNCTION", 2985000d1cc1SJoe Perches "Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr); 29864a0df2efSAndy Whitcroft } 29874a0df2efSAndy Whitcroft } 29884a0df2efSAndy Whitcroft 29894a0df2efSAndy Whitcroft# no volatiles please 29906c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 29916c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 2992000d1cc1SJoe Perches WARN("VOLATILE", 2993000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 29944a0df2efSAndy Whitcroft } 29954a0df2efSAndy Whitcroft 299600df344fSAndy Whitcroft# warn about #if 0 2997c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 2998000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 2999000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 3000de7d4f0eSAndy Whitcroft $herecurr); 30014a0df2efSAndy Whitcroft } 30024a0df2efSAndy Whitcroft 3003f0a594c1SAndy Whitcroft# check for needless kfree() checks 3004f0a594c1SAndy Whitcroft if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 3005f0a594c1SAndy Whitcroft my $expr = $1; 3006f0a594c1SAndy Whitcroft if ($line =~ /\bkfree\(\Q$expr\E\);/) { 3007000d1cc1SJoe Perches WARN("NEEDLESS_KFREE", 3008000d1cc1SJoe Perches "kfree(NULL) is safe this check is probably not required\n" . $hereprev); 3009f0a594c1SAndy Whitcroft } 3010f0a594c1SAndy Whitcroft } 30114c432a8fSGreg Kroah-Hartman# check for needless usb_free_urb() checks 30124c432a8fSGreg Kroah-Hartman if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 30134c432a8fSGreg Kroah-Hartman my $expr = $1; 30144c432a8fSGreg Kroah-Hartman if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) { 3015000d1cc1SJoe Perches WARN("NEEDLESS_USB_FREE_URB", 3016000d1cc1SJoe Perches "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev); 30174c432a8fSGreg Kroah-Hartman } 30184c432a8fSGreg Kroah-Hartman } 3019f0a594c1SAndy Whitcroft 30201a15a250SPatrick Pannuto# prefer usleep_range over udelay 30211a15a250SPatrick Pannuto if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) { 30221a15a250SPatrick Pannuto # ignore udelay's < 10, however 30231a15a250SPatrick Pannuto if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) { 3024000d1cc1SJoe Perches CHK("USLEEP_RANGE", 3025000d1cc1SJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line); 30261a15a250SPatrick Pannuto } 30271a15a250SPatrick Pannuto } 30281a15a250SPatrick Pannuto 302909ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 303009ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 303109ef8725SPatrick Pannuto if ($1 < 20) { 3032000d1cc1SJoe Perches WARN("MSLEEP", 3033000d1cc1SJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line); 303409ef8725SPatrick Pannuto } 303509ef8725SPatrick Pannuto } 303609ef8725SPatrick Pannuto 303700df344fSAndy Whitcroft# warn about #ifdefs in C files 3038c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 303900df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 304000df344fSAndy Whitcroft# print "$herecurr"; 304100df344fSAndy Whitcroft# $clean = 0; 304200df344fSAndy Whitcroft# } 304300df344fSAndy Whitcroft 304422f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 3045c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 3046000d1cc1SJoe Perches ERROR("SPACING", 3047000d1cc1SJoe Perches "exactly one space required after that #$1\n" . $herecurr); 304822f2a2efSAndy Whitcroft } 304922f2a2efSAndy Whitcroft 30504a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 3051171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 3052171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 30534a0df2efSAndy Whitcroft my $which = $1; 30544a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3055000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 3056000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 30574a0df2efSAndy Whitcroft } 30584a0df2efSAndy Whitcroft } 30594a0df2efSAndy Whitcroft# check for memory barriers without a comment. 30604a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 30614a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3062000d1cc1SJoe Perches CHK("MEMORY_BARRIER", 3063000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 30644a0df2efSAndy Whitcroft } 30654a0df2efSAndy Whitcroft } 30664a0df2efSAndy Whitcroft# check of hardware specific defines 3067c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 3068000d1cc1SJoe Perches CHK("ARCH_DEFINES", 3069000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 30700a920b5bSAndy Whitcroft } 3071653d4876SAndy Whitcroft 3072d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 3073d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 3074000d1cc1SJoe Perches WARN("STORAGE_CLASS", 3075000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 3076d4977c78STobias Klauser } 3077d4977c78STobias Klauser 3078de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 3079de7d4f0eSAndy Whitcroft# storage class and type. 30809c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 30819c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 3082000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 3083000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 3084de7d4f0eSAndy Whitcroft } 3085de7d4f0eSAndy Whitcroft 30868905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 30878905a67cSAndy Whitcroft if ($line =~ /\b(__inline__|__inline)\b/) { 3088000d1cc1SJoe Perches WARN("INLINE", 3089000d1cc1SJoe Perches "plain inline is preferred over $1\n" . $herecurr); 30908905a67cSAndy Whitcroft } 30918905a67cSAndy Whitcroft 30923d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 30933d130fd0SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 3094000d1cc1SJoe Perches WARN("PREFER_PACKED", 3095000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 30963d130fd0SJoe Perches } 30973d130fd0SJoe Perches 309839b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 309939b7e287SJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 3100000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 3101000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 310239b7e287SJoe Perches } 310339b7e287SJoe Perches 31045f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 31055f14d3bdSJoe Perches if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 31065f14d3bdSJoe Perches WARN("PREFER_PRINTF", 31075f14d3bdSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr); 31085f14d3bdSJoe Perches } 31095f14d3bdSJoe Perches 31108f53a9b8SJoe Perches# check for sizeof(&) 31118f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 3112000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 3113000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 31148f53a9b8SJoe Perches } 31158f53a9b8SJoe Perches 3116428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 3117428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 3118000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 3119000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 3120428e2fdcSJoe Perches } 3121428e2fdcSJoe Perches 3122554e165cSAndy Whitcroft# Check for misused memsets 3123d7c76ba7SJoe Perches if (defined $stat && 3124d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 3125554e165cSAndy Whitcroft 3126d7c76ba7SJoe Perches my $ms_addr = $2; 3127d7c76ba7SJoe Perches my $ms_val = $8; 3128d7c76ba7SJoe Perches my $ms_size = $14; 3129d7c76ba7SJoe Perches 3130554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 3131554e165cSAndy Whitcroft ERROR("MEMSET", 3132d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 3133554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 3134554e165cSAndy Whitcroft WARN("MEMSET", 3135d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 3136d7c76ba7SJoe Perches } 3137d7c76ba7SJoe Perches } 3138d7c76ba7SJoe Perches 3139d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 3140d7c76ba7SJoe Perches if (defined $stat && 3141d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 3142d7c76ba7SJoe Perches if (defined $2 || defined $8) { 3143d7c76ba7SJoe Perches my $call = $1; 3144d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 3145d7c76ba7SJoe Perches my $arg1 = $3; 3146d7c76ba7SJoe Perches my $cast2 = deparenthesize($8); 3147d7c76ba7SJoe Perches my $arg2 = $9; 3148d7c76ba7SJoe Perches my $cast; 3149d7c76ba7SJoe Perches 3150d7c76ba7SJoe Perches if ($cast1 ne "" && $cast2 ne "") { 3151d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 3152d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 3153d7c76ba7SJoe Perches $cast = $cast1; 3154d7c76ba7SJoe Perches } else { 3155d7c76ba7SJoe Perches $cast = $cast2; 3156d7c76ba7SJoe Perches } 3157d7c76ba7SJoe Perches WARN("MINMAX", 3158d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 3159554e165cSAndy Whitcroft } 3160554e165cSAndy Whitcroft } 3161554e165cSAndy Whitcroft 3162de7d4f0eSAndy Whitcroft# check for new externs in .c files. 3163171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 3164c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 3165171ae1a4SAndy Whitcroft { 3166c45dcabdSAndy Whitcroft my $function_name = $1; 3167c45dcabdSAndy Whitcroft my $paren_space = $2; 3168171ae1a4SAndy Whitcroft 3169171ae1a4SAndy Whitcroft my $s = $stat; 3170171ae1a4SAndy Whitcroft if (defined $cond) { 3171171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 3172171ae1a4SAndy Whitcroft } 3173c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 3174c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 3175c45dcabdSAndy Whitcroft { 3176000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 3177000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 3178de7d4f0eSAndy Whitcroft } 3179de7d4f0eSAndy Whitcroft 3180171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 3181000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 3182000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 3183171ae1a4SAndy Whitcroft } 31849c9ba34eSAndy Whitcroft 31859c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 31869c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 31879c9ba34eSAndy Whitcroft { 3188000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 3189000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 3190171ae1a4SAndy Whitcroft } 3191171ae1a4SAndy Whitcroft 3192de7d4f0eSAndy Whitcroft# checks for new __setup's 3193de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 3194de7d4f0eSAndy Whitcroft my $name = $1; 3195de7d4f0eSAndy Whitcroft 3196de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 3197000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 3198000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 3199de7d4f0eSAndy Whitcroft } 3200653d4876SAndy Whitcroft } 32019c0ca6f9SAndy Whitcroft 32029c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 3203caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 3204000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 3205000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 32069c0ca6f9SAndy Whitcroft } 320713214adfSAndy Whitcroft 3208caf2a54fSJoe Perches# check for multiple semicolons 3209caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 3210000d1cc1SJoe Perches WARN("ONE_SEMICOLON", 3211000d1cc1SJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr); 3212caf2a54fSJoe Perches } 3213caf2a54fSJoe Perches 321413214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 321513214adfSAndy Whitcroft if ($line =~ /__FUNCTION__/) { 3216000d1cc1SJoe Perches WARN("USE_FUNC", 3217000d1cc1SJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); 321813214adfSAndy Whitcroft } 3219773647a0SAndy Whitcroft 32204882720bSThomas Gleixner# check for semaphores initialized locked 32214882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 3222000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 3223000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 32241704f47bSPeter Zijlstra 3225773647a0SAndy Whitcroft } 322667d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 322767d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 3228000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 322967d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 3230773647a0SAndy Whitcroft } 3231f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please 3232f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 3233000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 3234000d1cc1SJoe Perches "please use device_initcall() instead of __initcall()\n" . $herecurr); 3235f3db6639SMichael Ellerman } 323679404849SEmese Revfy# check for various ops structs, ensure they are const. 323779404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 323879404849SEmese Revfy address_space_operations| 323979404849SEmese Revfy backlight_ops| 324079404849SEmese Revfy block_device_operations| 324179404849SEmese Revfy dentry_operations| 324279404849SEmese Revfy dev_pm_ops| 324379404849SEmese Revfy dma_map_ops| 324479404849SEmese Revfy extent_io_ops| 324579404849SEmese Revfy file_lock_operations| 324679404849SEmese Revfy file_operations| 324779404849SEmese Revfy hv_ops| 324879404849SEmese Revfy ide_dma_ops| 324979404849SEmese Revfy intel_dvo_dev_ops| 325079404849SEmese Revfy item_operations| 325179404849SEmese Revfy iwl_ops| 325279404849SEmese Revfy kgdb_arch| 325379404849SEmese Revfy kgdb_io| 325479404849SEmese Revfy kset_uevent_ops| 325579404849SEmese Revfy lock_manager_operations| 325679404849SEmese Revfy microcode_ops| 325779404849SEmese Revfy mtrr_ops| 325879404849SEmese Revfy neigh_ops| 325979404849SEmese Revfy nlmsvc_binding| 326079404849SEmese Revfy pci_raw_ops| 326179404849SEmese Revfy pipe_buf_operations| 326279404849SEmese Revfy platform_hibernation_ops| 326379404849SEmese Revfy platform_suspend_ops| 326479404849SEmese Revfy proto_ops| 326579404849SEmese Revfy rpc_pipe_ops| 326679404849SEmese Revfy seq_operations| 326779404849SEmese Revfy snd_ac97_build_ops| 326879404849SEmese Revfy soc_pcmcia_socket_ops| 326979404849SEmese Revfy stacktrace_ops| 327079404849SEmese Revfy sysfs_ops| 327179404849SEmese Revfy tty_operations| 327279404849SEmese Revfy usb_mon_operations| 327379404849SEmese Revfy wd_ops}x; 32746903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 327579404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 3276000d1cc1SJoe Perches WARN("CONST_STRUCT", 3277000d1cc1SJoe Perches "struct $1 should normally be const\n" . 32786903ffb2SAndy Whitcroft $herecurr); 32792b6db5cbSAndy Whitcroft } 3280773647a0SAndy Whitcroft 3281773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 3282773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 3283773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 3284c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 3285c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 3286171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 3287171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 3288171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 3289773647a0SAndy Whitcroft { 3290000d1cc1SJoe Perches WARN("NR_CPUS", 3291000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 3292773647a0SAndy Whitcroft } 32939c9ba34eSAndy Whitcroft 32949c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 32959c9ba34eSAndy Whitcroft my $string; 32969c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 32979c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 32982a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 32999c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 3300000d1cc1SJoe Perches WARN("PRINTF_L", 3301000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 33029c9ba34eSAndy Whitcroft last; 33039c9ba34eSAndy Whitcroft } 33049c9ba34eSAndy Whitcroft } 3305691d77b6SAndy Whitcroft 3306691d77b6SAndy Whitcroft# whine mightly about in_atomic 3307691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 3308691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 3309000d1cc1SJoe Perches ERROR("IN_ATOMIC", 3310000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 3311f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 3312000d1cc1SJoe Perches WARN("IN_ATOMIC", 3313000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 3314691d77b6SAndy Whitcroft } 3315691d77b6SAndy Whitcroft } 33161704f47bSPeter Zijlstra 33171704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 33181704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 33191704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 33201704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 33211704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 33221704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 3323000d1cc1SJoe Perches ERROR("LOCKDEP", 3324000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 33251704f47bSPeter Zijlstra } 33261704f47bSPeter Zijlstra } 332788f8831cSDave Jones 332888f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 332988f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 3330000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 3331000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 333288f8831cSDave Jones } 333313214adfSAndy Whitcroft } 333413214adfSAndy Whitcroft 333513214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 333613214adfSAndy Whitcroft # so just keep quiet. 333713214adfSAndy Whitcroft if ($#rawlines == -1) { 333813214adfSAndy Whitcroft exit(0); 33390a920b5bSAndy Whitcroft } 33400a920b5bSAndy Whitcroft 33418905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 33428905a67cSAndy Whitcroft # things that appear to be patches. 33438905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 33448905a67cSAndy Whitcroft exit(0); 33458905a67cSAndy Whitcroft } 33468905a67cSAndy Whitcroft 33478905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 33488905a67cSAndy Whitcroft # just keep quiet. 33498905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 33508905a67cSAndy Whitcroft exit(0); 33518905a67cSAndy Whitcroft } 33528905a67cSAndy Whitcroft 33538905a67cSAndy Whitcroft if (!$is_patch) { 3354000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 3355000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 33560a920b5bSAndy Whitcroft } 33570a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 3358000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 3359000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 33600a920b5bSAndy Whitcroft } 33610a920b5bSAndy Whitcroft 3362f0a594c1SAndy Whitcroft print report_dump(); 336313214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 336413214adfSAndy Whitcroft print "$filename " if ($summary_file); 33656c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 33666c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 33676c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 33688905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 33696c72ffaaSAndy Whitcroft } 33708905a67cSAndy Whitcroft 3371d2c0a235SAndy Whitcroft if ($quiet == 0) { 3372d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 3373d2c0a235SAndy Whitcroft # then suggest that. 3374d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 3375d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 3376d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 3377b0781216SMike Frysinger $rpt_cleaners = 0; 3378d2c0a235SAndy Whitcroft } 3379d2c0a235SAndy Whitcroft } 3380d2c0a235SAndy Whitcroft 3381000d1cc1SJoe Perches if (keys %ignore_type) { 3382000d1cc1SJoe Perches print "NOTE: Ignored message types:"; 3383000d1cc1SJoe Perches foreach my $ignore (sort keys %ignore_type) { 3384000d1cc1SJoe Perches print " $ignore"; 3385000d1cc1SJoe Perches } 3386000d1cc1SJoe Perches print "\n"; 3387000d1cc1SJoe Perches print "\n" if ($quiet == 0); 3388000d1cc1SJoe Perches } 3389000d1cc1SJoe Perches 33900a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 3391c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 33920a920b5bSAndy Whitcroft } 33930a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 3394000d1cc1SJoe Perches print << "EOM"; 3395000d1cc1SJoe Perches$vname has style problems, please review. 3396000d1cc1SJoe Perches 3397000d1cc1SJoe PerchesIf any of these errors are false positives, please report 3398000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 3399000d1cc1SJoe PerchesEOM 34000a920b5bSAndy Whitcroft } 340113214adfSAndy Whitcroft 34020a920b5bSAndy Whitcroft return $clean; 34030a920b5bSAndy Whitcroft} 3404